Skip to content
This repository was archived by the owner on Sep 27, 2018. It is now read-only.

Commit 2da8668

Browse files
author
GSI2013
committed
added step-by-step installation instructions and license info
1 parent 6e1f8aa commit 2da8668

File tree

1 file changed

+13
-2
lines changed

1 file changed

+13
-2
lines changed

README.textile

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,26 @@ Be sure to know your reasons when using it.
77

88
h2. Installation
99

10-
Set the variable @PATH_TO_JEKYLL_SITE@ correctly and run these commands accordingly:
10+
Set the constant @PATH_TO_JEKYLL_SITE@ correctly and run these commands accordingly:
1111

1212
pre. echo "gem 'jekyll_image_encode'" >> $PATH_TO_JEKYLL_SITE/Gemfile
1313
bundle
1414
echo "require 'jekyll_image_encode'" >> $PATH_TO_JEKYLL_SITE/_plugins/ext.rb
1515

1616

17+
*Alternatively* you may accomplish the same without @echo@ and @bundle@:
18+
19+
# Install the plugin by running @gem install jekyll_image_encode@
20+
# Add the line @require 'jekyll_image_encode'@ to *./_plugins/ext.rb*
21+
22+
1723
h2. Usage
1824

1925
In the source attribute of an HTML *img* element, call the *base64-tag* providing the image URL as the only parameter:
2026

21-
pre. <img src="{% base64 http://example.org/image.png %}" />
27+
pre. <img src="{% base64 http://example.org/image.png %}" />
28+
29+
30+
h2. License
31+
32+
Jekyll Image Embed is released under the "MIT License":http://www.opensource.org/licenses/MIT.

0 commit comments

Comments
 (0)