octicons_v2_helper 0.0.0.pre.35911d9 → 0.0.0.pre.36648fb

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9cf21e7021a5f88f1758239a259b5e9e671277abf1f15dd00b3774b10723c50a
-  data.tar.gz: 823a891acbf4e182aac66d8bdc0779c13bf51add0303b1aaf90c4f0aa6cf7905
+  metadata.gz: e7c5be4203fdcf4b2dadeb77dcc3c13942ce56e3f57c9c862ab982e1699ca912
+  data.tar.gz: d7b675009a0eb661fca8946c061064f7d9e002706c911ed05f0fd0f42ad9a541
 SHA512:
-  metadata.gz: 884cc9f14222492ae0ffcc2240fd4474304575e2877fd369044fdccea83a09a42d19ee9f858a3646576be57c92295e5f715da0c7cb6df05290b324a502b23ec6
-  data.tar.gz: 3fed21d17549e2d46c7d39c3d10044ce0ff87d7a0913ef6862ac92bd47bc42d23510ff3dc3d5618a93ae5c54386e09bfb1dec0d96c71a7985e9ada15fa6aa839
+  metadata.gz: 55617ad9be6c16fe67249c89b5b7bb6bb3b9636e5c4ef3f8341e01930eec424febd84038f86c91695245d556cb95d87c746eba9d4352b5d3b59af992656f9517
+  data.tar.gz: d77a2dd636020b93e74b89d6e864ad77798be3f46d711c70ac01835f6e219df9d6e9275ab5cb01ada94920a5d6dedfb0ec22d4ec370818d0a62993059f4f1531

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/