octicons_v2_helper 0.0.0.pre.5f3829a → 0.0.0.pre.06b15aa

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e596cf662ad56789fce71f7161d10b0573c203e4da90a9438d007de297ed8e54
-  data.tar.gz: bebfa3544eaecb4c50aa075b1256cbefe61a4d42a79b6c4b3cca31d382eefcf2
+  metadata.gz: 495e2574603ad6540494690101d3fcd6feb2fb85ebcdc1a24ced21a0e2c46ff3
+  data.tar.gz: a2a063f23843722f16686a438bd17aaa1109c83d6850279e71e648167a4d3cc3
 SHA512:
-  metadata.gz: 6bdfdab4b65294bf63b9d0e369d0929f15e085ff8e11e03c5d3133844cb6c2f0b9b3ee973e255b1559a748b80de0008d4e135e7c2e1c3ee72b50eb4e3d18512a
-  data.tar.gz: 39ebe9c74d6f68cbd4d05e3d60c32313079ce96129fc87f1392ddf83ccf428d572ed1a2ea0db08e85e953f6c42040c61d267aa89cdeba67ce4ce4aabc613fade
+  metadata.gz: b9dbf099c0cd3c1bb44bdfb8f550b0bc75d39c57f62dbe1af96c1d7a186704f935c347bb0820c3479224fa66c193f4d996bc9d44eeb1c7187ca25f5f9ffac8cb
+  data.tar.gz: f5888ba0a8f396741a43ed91cf21e0e3628341a51b63925ee135d23b680c1ad732ee82e39ed8dcb59e5d4bf9c0bc59fcc80825ed5444439f203c977d6950908b

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/