octicons_v2_helper 0.0.0.pre.3751a86 → 0.0.0.pre.6933f36

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6333ca84f693d3ba7b14c17072b224987b079c6c1ee815073babbb49c2e5c7c
-  data.tar.gz: 5ffa82a77b2c34a5201659165c91d76467ab527ac034e70d4d4a03593abed34b
+  metadata.gz: a0632206ddf7136ce7783181e6c8c3024f01068a4043b91cfb6ca9dde2120c2f
+  data.tar.gz: 80916b135a9550934d0550cc4180b8ae0f928b859f98b0ba7b2155b392db2c7f
 SHA512:
-  metadata.gz: 2c03860198f4e33638ebeae9e6ec39419b7a2e26e3d70da4f432b5468f1a2ca6a6adaf3c369d664af361db9842142a77dbdc2b2c112e1aaee37bed8ee57ed8a6
-  data.tar.gz: 004fe07ea2db9a4b16964d7651cef1923cb813c8feba5d3a6b691b26d13ccd19fb7687453057644daf2db5f05230ad9be1ff194dab96cab82710c87591f60ab1
+  metadata.gz: caaa4723eafdca3644383edca60a07947d207c47c95a09348e31f16bc699a099a71d0d4d6f931b406f6af79ed98398d78e7525bec280d7fd614f487203d099c9
+  data.tar.gz: 82dd281991a7ab1ade0d149897b3534fe4a6dc74c064c446c21eb0b74685820faf8712d8f1aadd593c7e03973d3ae8d498dbb67c02c15d17c6e67bfc23a01def

data/README.md

@@ -1,5 +1,39 @@
-# octicons_helper
+# Octicons rails helper
 
 [![Gem version](https://img.shields.io/gem/v/octicons_helper.svg)](https://rubygems.org/gems/octicons_helper)
+[![Build Status](https://travis-ci.org/primer/octicons.svg?branch=master)](https://travis-ci.org/primer/octicons)
 
-See https://primer.style/octicons/packages/rails
+> A rails helper that inlines SVG octicons
+
+This rails helper let's you easily include svg [octicons][octicons-docs] in your rails apps.
+
+## Install
+
+1. Add this to your `Gemfile`
+
+    ```rb
+    gem 'octicons_helper'
+    ```
+
+3. Use this tag in your erbs
+
+    ```rb
+    <%= 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/