jekyll-octicons_v2 0.0.0.pre.35911d9 → 0.0.0.pre.36648fb

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b09431ca263ce6e9548f2b8183a2b4f58e391e1a0628d0d4e71832ea4baea9c2
-  data.tar.gz: e140bb911d649189747209a4a344315c7ecd79f74e9528c60bf2af960f1c4db0
+  metadata.gz: 539d9e6a26aaa542703af4dc57183f81aa07c617dc9c6c5fc6b99fa0b90217cd
+  data.tar.gz: 84e4ac5ffbc05f50d6f7ecc883a6a54f5bd7069ae6c4c3ea6e93517d2ad062c1
 SHA512:
-  metadata.gz: a879873a35e1227be82547d0d5ce319fb78e66e9c26e8b8829517afd586149f07e5a37f9ccd75359fd81fea1d68b1f43c2c334a7411b8fdb2f9102d1fae06f04
-  data.tar.gz: d7361bc36f3ceed9a39e46f34fc465e48660bb07a8bed01f3f8e825013c4de7f68e17ee68b399c7c2e7124c7aabe00c71c978a1a17f450f6a5c36b37f1c1d846
+  metadata.gz: f0fdd96a07ee2dde76431f4d397c40d87a52ce1d586294fe151eb931fdf71a01d4c5635bef66d22a52302b1949ee7f13a85f0dfb633abacecd7531b1fae7d1a6
+  data.tar.gz: 4e898a50c1d00c3c8d2ad486c0429d77d241b39a3f69e4e8bf05317fafb1b9e12980d14b50a3cb32d6c72b7df84ee5a31f95749174531e9f59caa019578d2988

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/