jekyll-octicons_v2 0.0.0.pre.bd0d1dd → 0.0.0.pre.bd1caad

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1357f82cd45a493b9529b5f533df27946ff9204d5f1986c5874b13cd69afbbd4
-  data.tar.gz: 7345122ad44a8813292b9f00ca4e77fadc6ad538967395773c9bf73c6229d983
+  metadata.gz: fb09a17f8c979c91d03bde850894b02f7617359fbaa8b94b61ec8e9f864be6bd
+  data.tar.gz: 9c84b251aeae552d4cb725d80781aea6f1398e462e67d76ffb033598cf60260e
 SHA512:
-  metadata.gz: 5a479571edda916c83eb71fa9f664f78a071f80dff5f723c77439bede604ad0fd67eda5690607367a48b9fd5b17a22b18ea01a2015fdeaf9b193c90a7a6289cf
-  data.tar.gz: a88c1132c92a234f5a9b50a5d3a953a5a3bf68384ab0839d18f116e1bbfe588b35c43ec79d227093332c15b989ba7228cc32bb8157b5aed7add0dd2c5cd84dac
+  metadata.gz: d4a787e56e5a983fe5112ad5d34bca2a1c1a21dd6240c2fdf5072e88ea9bb237d317766d18deb9c3b8873a1625e407fb9d53bf54dc7fea0b17688b84de165e4d
+  data.tar.gz: 65a6ef883d291bd9891b4bc2ad5e942e8c8fbff7c4d77a2bfe96fb4eb2e476fcf0b4eea874ae5130d36d0b58392bc9d1f4f41ddc6a65a0c139d38936dbdf9f55

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/