octicons_v2_helper 0.0.0.pre.61b6959 → 0.0.0.pre.064e3ab

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: 38dcbf9313422946bf7bc9ba6ae844ea2b3a894b65fb876b0b29a22964eff7aa
4
- data.tar.gz: 9dd6c013a98ed408edb6e81d7fc76fc09c84cd9cf9c66e0b28561a13577394c8
3
+ metadata.gz: 04101460fb7a9f43c447637b97cbfc65ae082add615951fd34251a6f17c040cb
4
+ data.tar.gz: 4e64a1f0b665754c545e7803c80eb68cbd51ed6a6704d5f52c9f7d0cf03b033c
5
5
  SHA512:
6
- metadata.gz: 6848eafc1e68b935bb3b9f9716fdda34d7f19937e7df58813755ef8db07fed29e5e898880fe55d64888947c60a15b0585d187448200dc89241a33297f0f7d96e
7
- data.tar.gz: 8d4a9a5b773ba54219658f78c93839857c1939752c75ededf2f1b0894f1f5db3e9c47e2a0017606f429d7a9e5c4d45f372696ccf22f9c964d09b05e8791d4de2
6
+ metadata.gz: 866b199096cb85245c5fd679135f77ac5da6706bdd673a39fbdde549ccd634d4f1980237304e0badac589444f5ad5de31014ab000ab723ecd804bd23f04e9cf9
7
+ data.tar.gz: 83192b5580891486fab2ed48514bdb3c99325efa3dd067cacb953f0eba7c7a98a3caf3d5048dd39bd8a3981eff34fbe5735d6a2712d59e5372c09e096042a870
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/