octicons_helper 17.11.1 → 18.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba69b0d12e14e9ddd0b6f24d8de467d3496d93fe0d6f8d7ff6c725a0e192a150
-  data.tar.gz: 9c9c31cf8fbfaed7afaf4f5c500021e074a9774046250ac8613a258385531017
+  metadata.gz: c2e94dfaabd69c7b3cf5c27318381d08c6cb9ffe57ed6da6ea53671e1ae401bd
+  data.tar.gz: 1eb8351b66933385abb3cf1136d0be377e91d180933c9f2a95ee9d7670debcad
 SHA512:
-  metadata.gz: 6f50ee8f2d0d8ad10d5a88ba8edf7d651b1b5f95425e9c85a900ed58c26fd8b0985b766bd6bf7392cc6ea9e85b75ab9b380160b209df5dc82b8d9bc15f4338bb
-  data.tar.gz: e3d9201b30773aa4845398572cc349e4123a75fdf26ea5380120f395165704ea381c8da27a28bf58135c82acec0a7ac98086748838e362b01437d88c759c69fc
+  metadata.gz: 2c7738b79301027ad7df6a11c9c64a6e9ff453633c7fbdfa3c956021edc02de193530cad021de153b35fb89437855868755fd011b4ad7cb25a8ab6cfe951243f
+  data.tar.gz: 386a2db11150ffcc17ae0210e9ce36b0567e5babf4ac0587b20975b5ed2c4eaafb55440b08abee5e11e5e0f48b13f4c29ab0588864f2902cf5dd5b3cbf7a33ca

data/README.md

@@ -2,4 +2,20 @@
 
 [![Gem version](https://img.shields.io/gem/v/octicons_helper.svg)](https://rubygems.org/gems/octicons_helper)
 
-See https://primer.style/octicons/packages/rails
+
+This rails helper lets you easily include svg octicons 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 [`@primer/octicons`](/packages/javascript) npm module. You can also npm install that package and include `build/build.css` in your styles.