README.md in jekyll_img-0.1.4 vs README.md in jekyll_img-0.1.5
- old
+ new
@@ -1,11 +1,11 @@
`jekyll_img`
[](https://badge.fury.io/rb/jekyll_img)
===========
-`Jekyll_img` is a Jekyll plugin that displays images,
-and provides support for captions and URLs.
+`Jekyll_img` is a Jekyll plugin that embeds images in HTML documents, with alignment options,
+flexible resizing, default styling, overridable styling, an optional caption, and an optional URL.
See [demo/index.html](demo/index.html) for examples.
Run the demo website by typing:
```shell
@@ -76,11 +76,11 @@
The wrapper allows for a simple, consistent approach regardless of whether a caption is generated or not.
The wrapper width is identical to the displayed image width.
Within the wrapper `<div />`, the embedded `<img />` is displayed with `width=100%`.
If a caption is required, the generated `<figure />` only makes the space taken by the generated HTML longer;
-the image width and height is not affected.
+the image’s width and height are not affected.
The wrapper will not exceed the width of the tag that encloses it if the `size` parameter has values `eighthsize`, `fullsize`, `halfsize`, `initial` or `quartersize`.
The wrapper's width can be defined independently of its enclosing tag by using [CSS units](https://developer.mozilla.org/en-US/docs/Learn/CSS/Building_blocks/Values_and_units#numbers_lengths_and_percentages) for the `size` parameter:
`Q`, `ch`, `cm`, `em`, `dvh`, `dvw`, `ex`, `in`, `lh`,
@@ -95,15 +95,9 @@
```ruby
group :jekyll_plugins do
gem 'jekyll_img'
end
-```
-
-Also add it to `_config.yml`:
-```yaml
-plugins:
- - jekyll_img
```
And then execute:
$ bundle install