octicons_helper 17.12.0 → 18.0.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 89dac843a9b8581ae8c37e1adc9a0313c2ffd6099a8a3e57bedadefecccf2f10
4
- data.tar.gz: 99ed129084c3253f9377eb8ad667c266068917fc56f5588a564acea55098929c
3
+ metadata.gz: c2e94dfaabd69c7b3cf5c27318381d08c6cb9ffe57ed6da6ea53671e1ae401bd
4
+ data.tar.gz: 1eb8351b66933385abb3cf1136d0be377e91d180933c9f2a95ee9d7670debcad
5
5
  SHA512:
6
- metadata.gz: 5789fce86c699da60fa85c7b8a8aa64aa8fb3fc7f9c055e5ebabead462f3a92eb9e286e7dbd22237137cba85830bc02c05f0dbefaab384dd15e11cfb752eb204
7
- data.tar.gz: ccc3152680945f6655c8a2e82e78439c601a604539cacd29b54353cd0d6d303f4d112d281e3af4e2d89df0f606ae52d5fcc304500823d533e5018c98276954ea
6
+ metadata.gz: 2c7738b79301027ad7df6a11c9c64a6e9ff453633c7fbdfa3c956021edc02de193530cad021de153b35fb89437855868755fd011b4ad7cb25a8ab6cfe951243f
7
+ data.tar.gz: 386a2db11150ffcc17ae0210e9ce36b0567e5babf4ac0587b20975b5ed2c4eaafb55440b08abee5e11e5e0f48b13f4c29ab0588864f2902cf5dd5b3cbf7a33ca
data/README.md CHANGED
@@ -2,4 +2,20 @@
2
2
 
3
3
  [![Gem version](https://img.shields.io/gem/v/octicons_helper.svg)](https://rubygems.org/gems/octicons_helper)
4
4
 
5
- See https://primer.style/octicons/packages/rails
5
+
6
+ This rails helper lets you easily include svg octicons in your rails apps.
7
+
8
+ ## Install
9
+
10
+ 1. Add this to your `Gemfile`
11
+
12
+ ```rb
13
+ gem 'octicons_helper'
14
+ ```
15
+
16
+ 3. Use this tag in your erbs
17
+
18
+ ```rb
19
+ <%= octicon "alert", :height => 32, :class => "right left", :"aria-label" => "hi" %>
20
+ ```
21
+ 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.