octicons_v2_helper 0.0.0.pre.fc97238 → 0.0.0.pre.fcf1e9b

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 453362d3aca1c619b8679a11fc061c2af0fe82ced0ada99f638becbdab14f697
-  data.tar.gz: 0a63688a333415d9d7c1fcc100e7aba5be0fad636c69e2981186df1fa8e67ec7
+  metadata.gz: 6fb6f055c3338b9a251f37eba5ad99ac6448de172ccde4afe1cf909eba812937
+  data.tar.gz: d200ea028d144ae0bb50078d97cc94b2d24a92b1cb6e9d714497c37e89403c3e
 SHA512:
-  metadata.gz: 2990ad9170dc7526f276d0db829838298fd285c2786678d3c3454aff474ce05caafa1a5a7036fb362241571900e5de22a082c4bf5e5dc4ed2608538c296ffd4a
-  data.tar.gz: 240c6f5b9a7cf3a86c35f2e9463e29ace7f01dd780fe8afcc4a9ae37ed6d15742c7d9fe518051409a422aece08efe69ff98032831fc4041ae1e28805207c9d2b
+  metadata.gz: 57b9e15c810264d45f03056d5f4287cef21026100603d17d913476b8bfea0352a0ece53c92d47a4bc535e40eed11c2d07a14f1d61046fa5f16474868ec2031ce
+  data.tar.gz: a2f48cb80378fb8faae6f8556c0ce7912fdc262a37552bceab116763c14d9cb9929defd023ed76835710adddef808860c02c9e162925b3e69067984d09ae43fe

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/