jekyll-octicons_v2 0.0.0.pre.519e9d5 → 0.0.0.pre.617ea40

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8eb6649ef500e6f84241093fa8bb157f63f502cdcb06b47a5850633ee9a6179
-  data.tar.gz: eb9a4d834f166854156dcbd7a2b66f54d96ae25ef1143cb696efb9a743d3e54f
+  metadata.gz: 8a1686e4c64d254d32c51ffe9e53860731fb8998380329c8e20d3793efda1cde
+  data.tar.gz: b05dcd15b67dcb91e24fe20e08c01f332a434c413c52f23183e335e2f37f81fd
 SHA512:
-  metadata.gz: 6f35f5fd7989f6dd05a39704bdcf72035e799b66b0716023e7091eb84a0eb45a70f60fcffee2e172cdc970531ad87d3e6e07c64414ca1842b9de77248e461bc7
-  data.tar.gz: d364f1ec066d9aa8a4b812ec90726fffd610e26f5ea529184be2c37ab3666093a77b50337ac70d37235229c62ca474a2e876a25e39354ec68a9ca5c17202817c
+  metadata.gz: 3195bc4ae5161691832b5642348a579e2bfba4711d94b1b8084f83f493939a59e1d0bb4676c431b182355ec471e95010128bc10e664b2bebb2e04cb4951b1433
+  data.tar.gz: b6bca66b9db72543f979eaf5f6f07071e5a387e39f7d968abfca0ed15109c6ae1cb9e72dbfd87bad96d6c9a462d0e2bdf55f6ce54b2b1fc97e32b6fda3520216

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/