octicons_v2_helper 0.0.0.pre.2e689fb → 0.0.0.pre.02f9d7a

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: ba26ad9471e5d5263a0665f0b6f15e4602565e7b14b62379b815be68e3c23d08
4
- data.tar.gz: fa649c58b39e96103fbacdfc7828f890932f0ea65c7b3e2c0e3aee75556da782
3
+ metadata.gz: bd123490c05ebf34e7052f7e1c7be6667fe41f5fe4d49942ce7b38101b44ed9a
4
+ data.tar.gz: 6d42c38382ecde59528839d9f04cf020824a640ceb1cad952e54c63ac2340ef7
5
5
  SHA512:
6
- metadata.gz: 77cb4878ef3b83b7d1af95fd35949c72dfafc514f8357b60c99713137fe147e1c6b0619e07d241a41fdf793220a7db14c2a6b8b911bf6de3988f70320447d47c
7
- data.tar.gz: fdc524fcbc6a789fef9b0a68d86c42fa9475e2dbcfba5546c305e48e31e75cde5e0e095e025d899cad9f45d441f6d537d23289b8f791c32794bcfe9eef800302
6
+ metadata.gz: 33579539ade152291519f9be5c72d69a4c9cdb5b017f5bce7c7f35e95a75096c413ac9624adfce6a037cc294f759044c6fbe869c89825b48d77bb36e1a9f49a0
7
+ data.tar.gz: 74fabe4fb148d5393aa795547457da3e3667e47fcc1d0708089a11e26181f190d0857631cf5f972a7c7842786a590bb44e0abafc82711c00b3849daaba03396e
data/README.md CHANGED
@@ -1,5 +1,39 @@
1
- # octicons_helper
1
+ # Octicons rails helper
2
2
 
3
3
  [![Gem version](https://img.shields.io/gem/v/octicons_helper.svg)](https://rubygems.org/gems/octicons_helper)
4
+ [![Build Status](https://travis-ci.org/primer/octicons.svg?branch=master)](https://travis-ci.org/primer/octicons)
4
5
 
5
- See https://primer.style/octicons/packages/rails
6
+ > A rails helper that inlines SVG octicons
7
+
8
+ This rails helper let's you easily include svg [octicons][octicons-docs] in your rails apps.
9
+
10
+ ## Install
11
+
12
+ 1. Add this to your `Gemfile`
13
+
14
+ ```rb
15
+ gem 'octicons_helper'
16
+ ```
17
+
18
+ 3. Use this tag in your erbs
19
+
20
+ ```rb
21
+ <%= octicon "alert", :height => 32, :class => "right left", :"aria-label" => "hi" %>
22
+ ```
23
+
24
+ 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.
25
+
26
+ ## Documentation
27
+
28
+ For a full list of options available, see the [octicons_gem documentation](../octicons_gem/#documentation)
29
+
30
+ ## License
31
+
32
+ (c) GitHub, Inc.
33
+
34
+ When using the GitHub logos, be sure to follow the [GitHub logo guidelines](https://github.com/logos).
35
+
36
+ [MIT](./LICENSE)
37
+
38
+ [octicons]: https://github.com/primer/octicons
39
+ [octicons-docs]: https://octicons.github.com/