jekyll-octicons_v2 0.0.0.pre.ff67761 → 0.0.0.pre.117d2c0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 81a44409e6731bc611f29f929ededaf48a196e7fcf531815876d58d60ec352ab
-  data.tar.gz: ad3581420c3e07852d1dd978c8eeddcad5fb3967e56a424dc27f5f782032bb26
+  metadata.gz: c0e43060a8b542d031dfe4f490ab3ca7972de1d41212eb2c633e2f44ba2efb35
+  data.tar.gz: a45fb13e77ff606c4fcbe62be180728e24a22f977ce33d8ac1ee155f75ae8314
 SHA512:
-  metadata.gz: b971d6ff918db75749c0fb4bb2ca0f0e978aaf49dd28fed77731bb1a0181a65924e5dfc86226c03e684d6f927cc6a57d775a30f73ece54467888da41e530c741
-  data.tar.gz: 9369c1dcaff5c0d4a277266dcc668ea184d74914cc710748dc2274a64e0cedf9c3aa7dc9269e2e0e2702df7d47f13a822ad1bea183698b0b4ddfad8647d8601c
+  metadata.gz: 9c38ff71f6a2b1b5660bff16987668ee3eff2bafa36ffc54898b67ce18a3233da4445949b2b4c51f102396cdde26f614976ac00463b1bd3558ffe72bfb48b912
+  data.tar.gz: dd7011babeba39ab2812a58e362056719d948da2cd370aef488bb11af51d602364462f946ad768b93a96b2fba6f1948c2cbfcbc04ad4cec021f7cacef1b15b24

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/