octicons_v2_helper 0.0.0.pre.519e9d5 → 0.0.0.pre.617ea40

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d801a0a6d0f3f25bb9a0dc630addc3dca33d38206e77e091a5d9613e2ebdf704
-  data.tar.gz: d2a361d0da762448657c1b9c85c8bd5fccef56d0b87a2c7302140f9537461d3c
+  metadata.gz: 72e3386a8efc2dfa29257b6d341393b2f7d65e5d62ca1fad54dba6d2be1af786
+  data.tar.gz: b52fd131af895a341ffa81920caa65cd251ca9da02839ed8c3ffccc34e133c21
 SHA512:
-  metadata.gz: 439425a64297ec310fd0193035bcbe9aeac2a783d5612078138756c361546a8b4c00287ed8fa2449dc1c4d2ac4832193942038f5c5aa7d111805bb9e7cbc7d6c
-  data.tar.gz: 01fc855d124735097e390c23f01fc848361372a28cd956e9df1a69367b5e1d432721190ec7cfe67344a408bf2bc59f56a192f50ce5869dd9516e272e46884314
+  metadata.gz: bd26a92a7767640a400c370f0ab167e5c7171b3f9d2d8e719100017b63a649eac5558bdbd0f390018760f64b4a6d380ebc02cf9d2f9e794d312ad1cb8211ef3f
+  data.tar.gz: 329ecf64714344ceb8afc3a651c8f35374bcd2460c38260b9a0280ab053db6b88dad8145af50d3a7bae9660e746538eb3d76d51217e8fcccb9fd15b014ff849e

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/