octicons_v2_helper 0.0.0.pre.bd0d1dd → 0.0.0.pre.bd1caad

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 01bcc72f4a407ec743838c741193410ee9a58f3f97952bc58f807acc85226ade
-  data.tar.gz: 1dae3ebe1d8c7184cc9d8790528637279d23bdbceeec10acf052876e5da16d6c
+  metadata.gz: a022efd7344af6092dd70f569a13ef4bfe455101b1c3de736753cd1372f65090
+  data.tar.gz: 6912a15ae6dddc09bc923cd036ff09b9bc9b8abb8572bcddb91d0d1330a7ec6d
 SHA512:
-  metadata.gz: f59cf6eaa89c77181608bcf8934b570ed5a3549389dac0d310d277fcf9143dfebf9812cf89bdde3e83689f79b708a6081d58c2da39d383b3d8be731d4a31584e
-  data.tar.gz: 570662d7ddb6195299b961c90bc4246b50c22d88281e4cbc8450e43eff4f6b83acd354fbaadac24ad663a58e92982b077ccb1bd8d01a59a6f41f5db3010e6357
+  metadata.gz: 42ebd1c281643fe909f19007ec2d604e05f8188efae2320bd1b3f5ab1cb57425c9fd7a538d38f2b828bfcd95b7a47075f279738162dba8cbad3bfadb2b187533
+  data.tar.gz: 709a75c55f7c0a1b3f977f00fbcbfb7e8e031424aef41d1ec8fddbc5bee1e57f3e5b529e7918d07c32b7a1300fda7a3357eb8f2bd72b4a0a654705557e3a49a8

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/