octicons_v2_helper 0.0.0.pre.59f3f81 → 0.0.0.pre.60ee16f

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4349fb26c260106cae7024213425361f603a1831ab493b6d90229fd6b3b95216
-  data.tar.gz: 1fc371a0c4beea173c0eff24f84a29142a9ca51768ef1cf8797e27f2d8659c71
+  metadata.gz: e086aa7a7ee5fd416da4ddcdea2a94d6edb65a301a87f7b767e8bf58c22c08dd
+  data.tar.gz: b5a4927280cc04929e8da6c0c63c5fae0d786468df92ecb32ae637ea5e23d846
 SHA512:
-  metadata.gz: b58ee85a2236f998bec878eedeb277bac6cb56de9801f3d7fc51073e3f95fa0f5bca1d8ae79551d8e6acf1eadf7180a3667c6bce01330f0085474f826279cb94
-  data.tar.gz: e8461ba12e0aff1cb956f8f619f03e2a450c91df878ac6ae9afa51cbdeebcaaf8cb974bec219c1716064cb5ca0a9985e3de7fc01a31d7b24db1ecc88a064b3b0
+  metadata.gz: f5ab94a15a750fa128752954176fe7bcf5bab176ce96c394f06205886d35a7590b7027ed9cd012c74718cc3d78a50301fcef812016e0f5efd4b2704b30214c55
+  data.tar.gz: d0a1358b73fb8e943b7f1fbe12265f2f16da06c3529b80f23f2570d91cd81feece017febbcece7f0046e71f56b2271bb182d7cc8093efdead0f488f245f0bbe2

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/