octicons_v2_helper 0.0.0.pre.9f56fa6 → 0.0.0.pre.9fd5b7c

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 710d646904fd2dc27ec51898c456e40488bd4a7f165454637ba3237310a663af
-  data.tar.gz: 4f57467931064794815d29452564a1a7d6d72970dd2924e8534aecdf480bf211
+  metadata.gz: 4336815e055933c78eb02a382d7d770bbd0f3395687fbf64f5a53ca66d4db4ee
+  data.tar.gz: 471a960f98a7ed40820b50ab17b8869c156664bc40392fca66b55c3dfeb55401
 SHA512:
-  metadata.gz: c205f767a7f974c649d1a0ac9d41528393ba08f8324f614534264c8807510c25242ee19bd51615b5ef606d7673cd631276e3bd31393dc00e166b920cbf3ffc6f
-  data.tar.gz: 4ea6c51ebd16fb6c1af0f242920216ff8bc8dce78d3e0ec306922cd9729637e20bc59a50d2d15f6a80ef4282c8b2652d64b87d652793deefdabad9767385b971
+  metadata.gz: e26c7637e2e2df449925253763510597d931c45d6fcbc2c3c70e75d56236036b76abddd9f8ac1c389dbc90455cd3d83df926d7ec1d486f3a3e45e9e5d86eed93
+  data.tar.gz: 70309a10712076ac539ebbe859354258a00eb30e389a31ce1358751220aab94b2c061253fbdaca82ff9a4da3e3b9062d0e23da7a8277cd402a8a54e33ee5cec4

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/