octicons_v2_helper 0.0.0.pre.7355f84 → 0.0.0.pre.08562a6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0b280c2e40d02698a28f61a26ce723df39e4befabb3eab7da308ff36a1654d9
-  data.tar.gz: 4adbced18ce23f1d8c43d4709588bd2005137f0499632dbed7b24e698366b2bb
+  metadata.gz: aac8f84a8617bbf12b273fd5e4b58c5214baaf478c5bb34864e5056e7ffc7c8c
+  data.tar.gz: cd18f723081dce2c1e5cc93ed7f512b854eaf7792cd2612d307a399487a1bfaf
 SHA512:
-  metadata.gz: a5e6482a13351ba87094c6c72216bf3d56c95c00f8b465b7096178e3497f081983419bb9980fe45fff7f1995b8acb90814e0140004c101e4c8153ba11582a98d
-  data.tar.gz: 4a12773f22aa9b04da172abe2ac73d83f1eb87afa17df702133b1544277d3f75087bdebfe10875ce2d17b2df7e0150669f996c45b14b25d636e6290c31e02630
+  metadata.gz: 347f4681b92613adc109e48a0ba51b1b9a086bad0ad864214eb6434804c5c4010facac795df0e965d9845baad69992ab6a2e3a76f42f18eb8624b324de6e10bb
+  data.tar.gz: 926446c16437d26bcea4dfcb93d4855b002a4216503708b34c0c12037dc77415e48386949a25452d5ab8501d913867aacc03fb0a48feb1680fb02ef22f51afbd

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/