jekyll-octicons_v2 0.0.0.pre.fc97238 → 0.0.0.pre.fcf1e9b

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e47c8fca221fedec1c2c56293ad26d0f19251026388bb3826af7b559b4ee9576
-  data.tar.gz: 3f186a33a2f9b3ddc23d7b4f783a34ccb1393e6b2928c90adb90c387dae6eb9a
+  metadata.gz: a688d4fd8d24e0022d32aeeabdd2e736c087806d0e1ae9ad5659cb03bc78abcc
+  data.tar.gz: 76f071e296bd6aba8e6daaa5cbc766dcd5eb637b463d5dd7fd732968a4cf75d9
 SHA512:
-  metadata.gz: 0e106acd99e38098f0e6ad44c9a23c1ea0b4a4427e6f43673ddb0015e008f8c37912a42660c9ef3fceab9129b29edeef3dcd256506d61bdc5ec4b64a9163db61
-  data.tar.gz: 8a7ccb25c0e7c340c79b214eacca6a3cc7cdcba1fec02ae564e774591cd19b4bf6e558595b95de523f780ba095c321c56024ef3d371ef7203ca81a3c0193405e
+  metadata.gz: 2d2575859ec7c409e406327fb735f8c69e0f9a978d0cdcb8ca3e6a5a3bc571b59f7c66b1495755b1a8a159ee4e1c3362b80b4ca6ee2dd09c571a2c549ead4d63
+  data.tar.gz: 43306da0927d0964f611c506f9c8a698931c56c6aa3ca4822bc40e919e0076dd02ca2d1ef235b735133380289e34d5811ba2fffe5679451223566b5eb2733ba2

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/