octicons_v2_helper 0.0.0.pre.ff67761 → 0.0.0.pre.117d2c0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34f37c243f249c6fce5aadcce5111c6f525a6bf86a53e99fe1716c73402b0e31
-  data.tar.gz: a0bc96ecd032a12b07da8f8012ef181e2ca470c9b45a887a43640d44f1f6df7d
+  metadata.gz: 82230fbc211f9e42d62f36a5cf6b4175afec6c3cc0f5a5609e2463082addfbf4
+  data.tar.gz: 334a047f068088ed2f28856e5c38127a575037529dd48f5ecb752869f6ee4f2c
 SHA512:
-  metadata.gz: d275d3a8541f9b4d778e66badde17014a431490c385ace6ec4d360b3ee4f80292d47abde6091df8a307a91ff7d058aa57e2751827f0d5446ed325bf96350eff0
-  data.tar.gz: 9da3fee037a3c99c7a42847fc037d91cbc7558cea574a6e92549dc7e8e759c6365f97b5a32d83e39af5f794dc55efe78c1fef0d68dd8cd1d851a54c92b409742
+  metadata.gz: 246d45275c6ea4dd9149773065131300f2704b8b19a974555cbb7d7aee0dffc6fea474d8ca2e848cc4079dedc322ba93c7e7ea41a705fb6edb53decdd3ee7a81
+  data.tar.gz: bc8e02859ec442bcb7394f0fc723ce79001853ff6499e98e6c93ef82cfa26b25c0ebabe12f6cdb8ad53cb4ce9609e58bcff642630464ce13e232eddb315f2ce9

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/