jekyll-octicons_v2 0.0.0.pre.d8dffb8 → 0.0.0.pre.d090062

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 254edac05ec0dab84f772fcdc9195463e0dec593457a06ad6bed4cd87d5549a6
-  data.tar.gz: e7ba52d6df81a96bf4bdce7e858193cf9d59fc5259eafd2726eb152086c40d57
+  metadata.gz: f31f80690d1fd2c8e8d8f116acb669f9ca76120a6f8c337beaede7149bc7d74f
+  data.tar.gz: d4a5e2a5b07af3719bad2352c9c6e29a700cb0bde5b09129bbe307bde9895443
 SHA512:
-  metadata.gz: 962a613474ebad2523acb3e392c72e6cbd1544de328ec17753bba72abe2ecaebda7368067c4b1462e5d288e98928390dcaac161786150c423440b204700197fb
-  data.tar.gz: b40045539881ed723833ebf01d3fb1f4d73db649a90b7bd8c6cef6d2db2e2cbd825d321a2a0960f58bfdc7e14ea04b66c3472d23c3e9e5f8d55a5cc6f2e287a1
+  metadata.gz: 05dbc5f77390e53850b722157cfde48e93494923883db225165f8edcc81ba83cd4bdad8c04c9f2dcdc1d7922751f64b14e3566d76435692abd6b6c374d51efe8
+  data.tar.gz: e1fe1e173d2e1d6573d92a744d1367dc521f893d9f7ccfc7719818482368aad4116eb15a7d1cf7c742a5db32621267635c1d34d5ad95b3d5fc3d303afd8ba6de

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/