README.md in octicons_helper-1.0.0 vs README.md in octicons_helper-2.0.0
- old
+ new
@@ -1,11 +1,11 @@
# Octicons rails helper
[](https://rubygems.org/gems/octicons_helper)
[](https://travis-ci.org/primer/octicons_helper)
-> A rails helper that injects Octicon svg into the page
+> A rails helper that inlines SVG octicons
This rails helper let's you easily include svg [octicons][octicons] in your rails apps.
## Install
@@ -16,22 +16,28 @@
```
3. Use this tag in your erbs
```rb
- <%= octicon "alert", :size => "large", :class => "right left", :"aria-label" => "hi" %>
+ <%= octicon "alert", :height => 32, :class => "right left", :"aria-label" => "hi" %>
```
The minimum CSS you'll need in your rails app is in the [octicons][octicons] repository. You can also npm install that package and include `build/octicons.css` in your styles.
## Documentation
For a full list of options available, see the [octicons_gem documentation](https://github.com/primer/octicons_gem#documentation)
## License
-_Code License:_ [MIT](./LICENSE) © [GitHub](https://github.com/)
+(c) 2012-2016 GitHub, Inc.
-_Font License:_ [SIL OFL 1.1](./LICENSE) © [GitHub](https://github.com/)
+When using the GitHub logos, be sure to follow the [GitHub logo guidelines](https://github.com/logos).
+
+_Font License:_ [SIL OFL 1.1](http://scripts.sil.org/OFL)
+Applies to all font files and SVG files
+
+_Code License:_ [MIT](./LICENSE)
+Applies to all other files
[octicons]: https://github.com/primer/octicons
[octicons-docs]: https://octicons.github.com/