jekyll-octicons_v2 0.0.0.pre.6be9593 → 0.0.0.pre.6e304cc

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2cd71ef0021cf6515afb9fb4790f5534f86d3d4290cfed6dd8fe8c945c189819
-  data.tar.gz: c2ecc40cd1fe9009d28b703a6dc241e918e10f1fee73d4f8cf119f214ad62969
+  metadata.gz: f6e8f6d89476da8ae1a75d4ea066cec1eb29314ad84963cc3cb3d01d149ee3a5
+  data.tar.gz: cbb68c4c931333d53cdc42f7a6eb3fc2db2b02bab4001904bf1e7c77e5bbd97c
 SHA512:
-  metadata.gz: 3713ecaa39fc3669441ae60aeef0dfb4b3b54e22183dd696c56f3db233921e871f8252d2ed6696ff9f41486b6e33ba49e5ff3ff5adb8f3a1e309e25a2f9937f8
-  data.tar.gz: 508cf4939ba4e34ebab5d368784cda2360661367c53b79bd90205f760ae02d31dd4cfe3c970de0e98781dd2e07f22c5daef5ca6a50eb57142a5c3d5e2b02f983
+  metadata.gz: ef1c3803a864b33c1518ef255cdc586625dda9c0352e30908c77c74a9c6afdf211b5a5f229a5627e922ec02178d92327b7b324f13a323ba32c28b3fde0a8b8f4
+  data.tar.gz: 03c1467239258608099d3dede742e1a773405f1abb5148e831c38a4ff04de06358b6b97bb9844c9e191237bfcf19aa29010bee5cd775bb00d4010a5237a3fccd

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/