jekyll-octicons_v2 0.0.0.pre.37939a1 → 0.0.0.pre.64504fa

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3dbd7cebe7cccc46a34289c626cfd4100b0662f2d6f5b0eb6b98ba6c9e461dfc
-  data.tar.gz: 683a98d1a1d0989dc543a8843fe6f82773195adf0edac9f0de3d8402480669e0
+  metadata.gz: 20496e0aa83bf53947e12b8d5c00e355b5034962a6ad6fc61fd91385e750d4a3
+  data.tar.gz: a1e63af9d1f4313ff33d2df268b938b6144c5c2684484491e2411a3d84a82cf7
 SHA512:
-  metadata.gz: 26ddfc4c7faafd94ccbda4dba2565adeb45405e095b595e66674b1f88f01b2e5c4c2e384a77c75167935d52a641617d7736fdb9313cbcad9d2e9b1dfd6fda26c
-  data.tar.gz: bfe0a3a4edf15461eaa2c0cc095853c860e8f83ceb3e590e925710a5508b50823466cfa4bfda9b3cc15967b11e989680c412749759b58eaada603f3551fff2db
+  metadata.gz: 65f8b3a6b19d9e9b079dc85449ac71f829adbc3521f455a06a50c63a58e529a4d08cc67e10f6cc79c0c5b45d9ab3fecff3ea57d38d02ca0cd902468abfd1c30c
+  data.tar.gz: 9eb42a3650c678ea1e2d1b3f11395af7888f2c08744071cb97b4a454f1bbffa66a20a0671dcaa8c00dca91391fe99aa3e85e890392c3e814f9f7f5bb0b211ab3

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/