octicons_helper 0.0.0.pre.b3fa573 → 0.0.0.pre.b6b9458

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 611f8d373995aaac5fb4a894320cb8171ebca62d2c3d0b55baa68c63cab8bc58
-  data.tar.gz: 612adf99c1378074260f04a1dd9d4f05527c2d6ed203efe4fc58280e6ca20551
+  metadata.gz: 412f714f1961d1e911279579fa1b76aff89c750501c5ee5e70ff0b9447c08bdd
+  data.tar.gz: afeeb6de6d2103e4fc3222de311d96f58482377325ee3ed5e8b3a730e48f1c55
 SHA512:
-  metadata.gz: 593975275d6a464423db5f3206ede2c21f7f6c0bb4acabc9c2dadfc4e7b98771057c13ce4789cfdef21dd906161ec5eaf4ae1616ad207d6ffb35483e6333d318
-  data.tar.gz: 67311a2efa82b48c863c134f4768502838ab13b01551ba96eac138d00ee7cfc6be0b3804792684e6a0c87dc185f573de79ffb62f51bb148a50af6c859e8a3fb6
+  metadata.gz: 51c1b1798235e88f0a1bbd036cd51b3cf464515ecb58deca104817c714109f14ac5d09f5205a5d65ef11597e9be0d85ff352307c2d5796b7d2cb3a530dc21d5b
+  data.tar.gz: f62d8f1596dd9e6491d1dd91027d1ca8ba9e48cc2f7800f22b6bb757d64479c9efc1848df37aea4cb77f96fde8724c78a2d1f662106257308e1f6adf1b9ad923

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 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/