jekyll-octicons_v2 0.0.0.pre.e6dc949 → 0.0.0.pre.e992db1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b782771063a4d17860a358d527073c17394ea2a71343cbea3cf600020fbddf30
-  data.tar.gz: 533da6ce92505e499cf928f4a5f7407baa5c80225a1a1b1bcf9ea4336162cdbd
+  metadata.gz: 762cec6b42ada844389dfc4f9c78ebca611199e009aa2de5b13d37a7c1a5f4f7
+  data.tar.gz: 684b9fb9239a451e75f4789cfead1948a3521b0a00dd12ec425cefdefabfce34
 SHA512:
-  metadata.gz: ac4ebcfce6c8b82cfbb0262702fcdbcfca6a0a04b1bf12a50a48697447e3affa824ea0f66d67b13238c609b2304477650a6977cb7a05893a847b3c05b92643b7
-  data.tar.gz: bb19fc014361601591c69cb34f393b26ddebb7e9a84aa5c23fbbb89808320bd0cf0275b918fec6b3ecef8f127bb698063c1ab1b8ddb4c7975ee38864b3d58fc8
+  metadata.gz: b48fb582602976dbe8cbfcd7dc818e60a310f807acfde717ac27f5f6e514ad03ac4688da51654eb21c46462c267d87c495352bca83d40969fe5e11c10629dd23
+  data.tar.gz: a7ba50f28fa4192888fe8a423a8a4be73dad33f9665be757b033915546221161f6487714b11571c5c60f2ec5f995d31202cbc1848f99c0b76185e7c6f5582dbf

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/