octicons_helper 0.0.0.pre.f375b88 → 0.0.0.pre.f553f16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e3429a0838f01e9c7680b2e2e3e8d2c3c53fe5a601d9127697b0f6b57dacc31
-  data.tar.gz: dbbf751a3138ad2c64a851b6d6776c1e7325e82fef92e5c23a96e79bd5a149e1
+  metadata.gz: fd18c557d2250992a130172e17d4d2364327e2f5856640c5358ab4b52f872f4f
+  data.tar.gz: 544ba1dd49a3d44404e744d6acc99e9347bc8c10ccb6dbe45cf30063acbefadf
 SHA512:
-  metadata.gz: 8d4ba56bd829e918cbe7bc70bbd19cb39d3c529d375d424c4bda30a4171514b3039fa3e6d4adf56c98c509619ed7b4b2d688ae034876bee2075aa6702d599596
-  data.tar.gz: 178cfd0f1b9b7e66cc6116b97fc231bef493a36d4cbfb9be9cf1f05e14f45cd0a25f992dd90db4ab6d5e6824fda507391cbe1c607e38287fbc80ab81911b1989
+  metadata.gz: 143ba5e8ddadb954627584e6e82321a2a477177ad43faae905831d45f28d396d882d621b7c5b007702e8310a38875e0b27a294078b56c5040516a7314125cad1
+  data.tar.gz: 8f22f5246f72b45064cd77aef283e964f6d7fd2ecd893792be4e5d2d192fb47c4e0313732fc7fb194b1c680ebc9a8fbbc105cc2720c356a70c161d4251c7bd71

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/