jekyll-octicons_v2 0.0.0.pre.94d0d86 → 0.0.0.pre.95fd1c2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80f4eec91aad9a08689aadbc7a20fee44d0b5ebb1ff177cb56baba58252e531b
-  data.tar.gz: 9d8c6722b0d1d868cf99d1c9a903525737a9eb5d0e8a251ab2e32c199f0ef807
+  metadata.gz: 250d84b32338c40838fb48d7a8ca5ed834a8b4f645d0530f0989c39fc82685d9
+  data.tar.gz: 46753c9de96aff518f7d43e438b04a95b8cf7f4244185998237fda54f4df4957
 SHA512:
-  metadata.gz: e09297027c8a5b73841f673912febb1ee1a818aaf1874289b3c8dce0fe41b1168d2b57e255a2df1c5295e235100249922ff0f2d85031c525d5174d48a860d3b9
-  data.tar.gz: ad88f21a56e9adbd1871ac2ac84b527a5e85129e44115f84d11ffb28974c9316735d6c9b9484ab9ddf397f314e1553b4cf5b2f83eccffd3062c27d89dbde3d5a
+  metadata.gz: cfe3c33f57d98d9d9bd320800dc0ee70b586061706cad5303de8653216a87fcdfb27fafa4815856e8bfe2a03ec599806cf0a305d1f9a99c15518038dcb812732
+  data.tar.gz: 6c1f54323ac9a8f23d8786cc55b645a408ff46bd7a992f87dadaee109baa4873ac2c9ffa0c0be8df2ad48d8fe7970ca08cd3175a58176615595e4a3013bfb0ac

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/