jekyll-octicons_v2 0.0.0.pre.7355f84 → 0.0.0.pre.08562a6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 27081e631f4c08f798f1b918183e72450dec89d9c85e6339ed705017dd847641
-  data.tar.gz: 8e3aa6075ea16a72813ec6a4a6952fba81dd94e73be55c346d124ae1163dabec
+  metadata.gz: ba797710f9036cc4195e946571d3997863ed5599b833ad88523badf8147b0ea9
+  data.tar.gz: 657f5919e59c4f75b83bef1325413607c7c8b854b7260eb62038c0e016119a5a
 SHA512:
-  metadata.gz: 6d27ac6a5b17f49fc2a9f864433a84aa922ae5b6cd0490d8c551de9af1da129840a643d3b4e13613e727c35f150a5e2ff2735a70d4fe1b98259fd19c32f0b3e8
-  data.tar.gz: c83babf3667b6e34efc537b23e0442c02d084f980bbc9945ae926679353b1b48081cd3fa9f03e41336156d4d984d2f66dab0acc44f6c7cfadf3f7fba2fb3133e
+  metadata.gz: 780b92bf2fb70b305787499315db96a8a61b4f965301ed86812aa6abaf26131667d03c9aff86415afe6caa396f53d8219691e8cf192581b870a534632dc6f9af
+  data.tar.gz: 61c4e855e49e7bea86d93aca079629b52dfd86bf84541c3da89d9fa70a64d67adee84d86cc82fb6cffd7f615f9a146e27990736b9f50b982ead199158a6ea42d

data/README.md

@@ -1,5 +1,46 @@
-# jekyll-octicons
+# Octicons jekyll tag
 
 [![Gem version](https://img.shields.io/gem/v/jekyll-octicons.svg)](https://rubygems.org/gems/jekyll-octicons)
+[![Build Status](https://travis-ci.org/primer/octicons.svg?branch=master)](https://travis-ci.org/primer/octicons)
 
-See https://primer.style/octicons/packages/jekyll
+> A liquid jekyll tag that injects Octicon svg into the page
+
+This jekyll liquid tag, is a plugin that will let you easily include svg [octicons][octicons-docs] in your jekyll sites.
+
+## Install
+
+1. Add this to your `Gemfile`
+
+    ```rb
+    gem 'jekyll-octicons'
+    ```
+
+2. Add this to your jekyll `_config.yml`
+
+    ```yml
+    gems:
+      - jekyll-octicons
+    ```
+
+3. Use this tag in your jekyll templates
+
+    ```
+    {% octicon alert height:32 class:"right left" aria-label:hi %}
+    ```
+
+We recommend including the CSS in the [octicons_node](../octicons_node/) module. You can also npm install that package and include `build/build.css` in your styles.
+
+## Documentation
+
+For a full list of options available, see the [octicons_gem documentation](../octicons_gem/#documentation)
+
+## License
+
+(c) GitHub, Inc.
+
+When using the GitHub logos, be sure to follow the [GitHub logo guidelines](https://github.com/logos).
+
+[MIT](./LICENSE)  
+
+[octicons]: https://github.com/primer/octicons
+[octicons-docs]: https://octicons.github.com/