octicons_helper 17.12.0 → 18.1.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: 82a45301361757889b50457452ef7649c294b1c99677712b621b4a530d58ce79
4
+ data.tar.gz: 9c7fb5a2c33d32b58faeca5d6dd8016147a816286bef22ae500c10c4a8047686
5
5
  SHA512:
6
- metadata.gz: 5789fce86c699da60fa85c7b8a8aa64aa8fb3fc7f9c055e5ebabead462f3a92eb9e286e7dbd22237137cba85830bc02c05f0dbefaab384dd15e11cfb752eb204
7
- data.tar.gz: ccc3152680945f6655c8a2e82e78439c601a604539cacd29b54353cd0d6d303f4d112d281e3af4e2d89df0f606ae52d5fcc304500823d533e5018c98276954ea
6
+ metadata.gz: 8b843dd44aa33b6fd9475b73ec257c65e6f2cc3b2ea8a47753c4e7bcef14ba1bacb3d231ad3f8e24f01aef14440e00bad53993d43667e86c49e51581908b8a65
7
+ data.tar.gz: 8ef182dab9dc0b52dac6a5036a4fa8097b268cf2df081691f5e0e6371680eb028f75b8663ad483c653c7108183c5e45596bf22bc9e84c00376e0a0cc04fdc5da
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.