jekyll-octicons_v2 0.0.0.pre.3751a86 → 0.0.0.pre.6933f36

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a6294ecea13518122ba8d699bb8062c1604602f885101a4be439775873e7d23
-  data.tar.gz: e927e5f7a2c9f7fd6e21770ce3b29a9d7cf7c2059d9283e9ff36c5c816c27cc0
+  metadata.gz: 49f48a436009d8f5d7c7bfcb58b28b01fd6261ec6b3cb6810612fbde62d5e452
+  data.tar.gz: 2f5392da42cc2cab07c5d20e194a7d3f9ac3679a37eee8fcd6517f6cdccdde62
 SHA512:
-  metadata.gz: c8263be0785f2661418f54d2638daab385e7c212a6be55a62689b93d985fa8bb6cf16bf2904b28805511e88dd3d0b53422322c4c5d07cf2c2616c260787e2f74
-  data.tar.gz: dc72c9f236a658b6f1a2db17a400fd3694e52dd62f410db538f5fd4f3fc434ef43362123b48a3c69e29754d667aa987c653b8aa2cfc5790aa1ab56844961f846
+  metadata.gz: 3bd895d166f39d2aaa3ffe4e2cc5c23bdb69ce1275f1e3fc9f0eae5e397d9b124c04df73cfa0bcde079e77979e88b3194d3ed564fcef877bbf6bb1f8b4ea1ed1
+  data.tar.gz: 3ee41286f7027759113019cd7d75aa8e1c8287a694e7aaf38395ecc16058cdb6dff8d9276b824d540e79d4ef7d9e28257198cbec74dac4018b6307b288cb75ff

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/