octicons_v2_helper 0.0.0.pre.d8dffb8 → 0.0.0.pre.d090062

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec133e422ece18c55430d5f70fa998ec80f8a6e040500c55b47f3de649c27985
-  data.tar.gz: 0dd8e643772dfa15be6655ff5bb498edf263d5dc1be6c2913a5d112b6df9cf12
+  metadata.gz: 0cb9ea0f4cf1d687d35d029cc01ecb7ee9f73238f377d8b60ba08a5c3acba161
+  data.tar.gz: f61e0137c1d5e81f010c4fa82f7ce34f8e4d302d3c0da33b85f89d907b6b11bd
 SHA512:
-  metadata.gz: 25437abf5bde24aeb50c14febc8b95843bf63e9f6b0baead664ad4e3e3a8ddfb605fc56f2b08097668e499a19528519a5654ec264814da73762aed85200ae8a0
-  data.tar.gz: fef915c4ed47ea581537ab54d299c7bb1580c4433c081d944bc094e1e76a679489929ffbf8ac5fd19f908f6890fd0fd9d6c1b716899e17313ce65bfa64f04e81
+  metadata.gz: 01b1f602157a8983a08506e6be7babfd20e8579c316a3df5fa3b582d913e197ddf1950f483ef9dcb6171324c168516310b674e8dd6b2ae65685d03365b2b1188
+  data.tar.gz: 34a423bccf71aac5915dcc4e6d55da339b5b04c16ba68c9a49b6fe5504c2fa523dc4c5f5b172ef2c716709b9bdb0ab9d39ddf6c816ed9e24d02552cd78141641

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/