octicons_v2_helper 0.0.0.pre.6be9593 → 0.0.0.pre.6e304cc

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b69107a3376f7db1446614fd9ed77d0743148f60798e7cc61955f9ef53f0c1d1
-  data.tar.gz: cf9e551a16aca946c8d73c151be7e6235addd2c0f7943c6441755a3cd1a6eafa
+  metadata.gz: c77bbf2a62d437d2f8b7f7e1add885d308d1921217ccfeef37bb523ba0f98fd9
+  data.tar.gz: 87e1c8d81a39bed346afd7abd89b1a680c31c9994d79225a4b8b316caa47bdc9
 SHA512:
-  metadata.gz: fd99118bcb882599673ee8b29203c63f5fb9b5847715cc6a8f8f675afd0a75d9a89ad3b4b4902bfb4b18d5146d3defdc7b9646e44b0ccda6aeac99075f77bb36
-  data.tar.gz: 3ae87a4a08bc4f5d761e77fc73eb8fd744cdfd75585ee8caf682fb5c3d6fc637b81fe1b149ed47bc3ca2410129b07e70803f6904e2a0754b60826aba1089bc94
+  metadata.gz: d64bfcfd8c92a11b6e81179dfc1996fd1f1f248e9fa29c25f9cf79ac073131ef48ba52ca8fdfd21bacf73a499db130d435487c23c8f427485002ec4c08b14b3c
+  data.tar.gz: 05da9108a05dc358647413f3927396ddb4fc66d6655b9c64cf2d582e75a38043b9972b7c8d3f77202e91650e9ac0eb2e0ffab52fe9256edc92af5534aeb7f6c2

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/