octicons_helper 0.0.0.pre.12c5e5a → 0.0.0.pre.13af5f6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d4c5743a31dc07e0a7a0bde4d285338779a8aca0797eca710cc829dc0f02aeb
-  data.tar.gz: 8f4f69e0614aa1d6839f6913136a61477ba52508c83dcc496b98f666f68fdb84
+  metadata.gz: 0a6255aeb1a16a2f1b1331b55602288f4132f102fbffeb8f3f700f74eebe8012
+  data.tar.gz: caa51ac8de506923822c49a4139936abdebf7d8af0dcf29f67b798e0bd04ca95
 SHA512:
-  metadata.gz: 82546e71df41aedeb54fddcc42bb7bd3375349eaee37e76b031047e43b276936f83695fba34ae58e11acdfff9725cc94d4ba2d984e1823ecfc1d1c72701ba353
-  data.tar.gz: f01f23d62aaac29813f8feae9c5d62f41d48fc9902103cccec3f8a6c651bc0a1c01b7d45da7e963da365a857d6aca75beae184be3d10838c7a021b288a1bf4f8
+  metadata.gz: 96ed8889cb18b431f01650eda5fffb16baef959c373fa954fbab08fda1c0b3ea4c1d3f5f6530fafaaae779bd4bbb1bf95ade8c9e88ee6b6c8c039cfc314d7478
+  data.tar.gz: 9f81316138011a396262ca9b6217488660f5dedf87ec43c2a9a414a16486c2946a3aaf83cad613e9ddc494ac00ff7f003f5414e994830ce5e428fe1d862f7ba2

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 GitHub Inc.
+Copyright (c) 2019 GitHub Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,5 +1,39 @@
-# octicons_helper
+# Octicons rails helper
 
 [![Gem version](https://img.shields.io/gem/v/octicons_helper.svg)](https://rubygems.org/gems/octicons_helper)
+[![Build Status](https://travis-ci.org/primer/octicons.svg?branch=master)](https://travis-ci.org/primer/octicons)
 
-See https://primer.style/octicons/packages/rails
+> A rails helper that inlines SVG octicons
+
+This rails helper let's you easily include svg [octicons][octicons-docs] in your rails apps.
+
+## Install
+
+1. Add this to your `Gemfile`
+
+    ```rb
+    gem 'octicons_helper'
+    ```
+
+3. Use this tag in your erbs
+
+    ```rb
+    <%= octicon "alert", :height => 32,  :class => "right left", :"aria-label" => "hi" %>
+    ```
+
+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.
+
+## Documentation
+
+For a full list of options available, see the [octicons_gem documentation](../octicons_gem/#documentation)
+
+## License
+
+(c) GitHub, Inc.
+
+When using the GitHub logos, be sure to follow the [GitHub logo guidelines](https://github.com/logos).
+
+[MIT](./LICENSE)  
+
+[octicons]: https://github.com/primer/octicons
+[octicons-docs]: https://octicons.github.com/