octicons_v2_helper 0.0.0.pre.94d0d86 → 0.0.0.pre.95fd1c2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70ff5a6613d0c3585bf431ea86d1c42b877c1ceb2f06ff88844c53814675dc83
-  data.tar.gz: 9989ac6371d417fe32a69cce8df3085aad26246d90f7546f3c0f421084e56b18
+  metadata.gz: e7e81c6e9257bf16cc7482d304405c96d87c44be090cab39069c278a3fb483f3
+  data.tar.gz: 337d41f320893a71d37405e160db8e049ff05d56d8ac5be06b2ce09c3465980f
 SHA512:
-  metadata.gz: f2ad92d4c529b8d778cf0f37920fea14cd36a4bcc4d7f590943ce7e041d7c01cc154d79db1ee4414946fa3f5a58d772ab3c19e60751f6e123da4738485a055bc
-  data.tar.gz: 92756d543bf3d81a70300de9c3a4b9973aca6182efed8148f2e5c802743501ed1af45e0fbc39136b9c6f1d1a63ca27a1d1ea7d5647a9b80cdc4f168dcfbed082
+  metadata.gz: a2fcea14d4d7698944567154849178b4f8a4cbb3f074d004e89eb3cc6d8faeb3738b547e9c8a5cd4e81b680e5fdd64b43f543fc71cbae068aed69ab41edf086c
+  data.tar.gz: 7c33d5b1c1e8e72d6e4f56ebed93f344833c03631f455bb4c1330f9c046cfdc5c5495222094180661a6d9a8f1c0eaec95f1227b45e2a50a9131fd4ef47e19fc6

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/