jekyll-octicons_v2 0.0.0.pre.59f3f81 → 0.0.0.pre.60ee16f

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9295bdeaaa131d9be932c2283abedbc9e658df3ab228b6ce85d8ed8b1ab820e8
-  data.tar.gz: d89569d3df1ec9b1e74e99956afc5829eacba803c216df65f6705d6e57e3aac4
+  metadata.gz: 6e105ca50c4641bd86b32b3e2aa1a96ef95d6d283f68c608a4559a52137fd26c
+  data.tar.gz: 39658745bc2235dfab91155fbad60202d5f30591228776ddbf9cbe996db712a2
 SHA512:
-  metadata.gz: 28b9f56c70a332cbc4ec36a3e31353a5649b46754af4aa7560aca3fec67c308d2198a97779ceba8fc2b2f000ead5a433d352b535428f067e04357f78ae5ed2c8
-  data.tar.gz: e522dc0b9f63f3af0ad59946cb0c6d9af6395c58c4aa2b7db51e06d6cc422f9de97c66985fba4945a5b854410c2f5f71530f31462526b970db55b4ba461fa9d8
+  metadata.gz: ed4900f0ecb707c5d943cadbd73fd4d1323ad1d3a4e064fad1d03f9855130539bc2544ba8b2b7279612fb429b13d7bdc9273216b8a83b3f8cbd184f6076092ef
+  data.tar.gz: 753b909276ee6a76297f131ab53f0294f9c8d62bc55c3d4ef7bc6e3b9ef0ef2acd58af650b5f68bc30fe716e0c66e41b63d641f93b4fb582a3d49754058515a5

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/