octicons_helper 0.0.0.pre.33bca3c → 0.0.0.pre.34d72ab11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e0efc6e5a141802b485f7bee139f74f105a05ac762f004c713d2fef50516848
-  data.tar.gz: ac9d7b5bafe430da7f9d8b252629a2eb588f243ded196896542ea59da4ee85ce
+  metadata.gz: 45a6721f3708d9caf93bd9cbf85e0a2148bd3de6fb2091258ce14900ee3034af
+  data.tar.gz: e6611becd89a66bbe6af9c55b4734884309aee21c766b94156a1249533e78441
 SHA512:
-  metadata.gz: cad319b48bac14b8846a7ab847d6c78f60a0d3e451e439885ca44142351b88f0947e8acedbec3b407cf2fe720ed4c3d31bc0ead25eb76a8dd45ab2a06808bf50
-  data.tar.gz: 112b10297c30d172f0173bd961a6706a43d9281d0820c96538fd9962b1e004156415a3c7693970a1d72b7133d6c5768f63e97de61deed88559f7993206833f7a
+  metadata.gz: 26cd90c5b9234cf5422ff2c910d12ae7bcee898aa5ae08d6c727229a31b10ce8697cdf94fe63628decd8e0c882f77d5d0d106142bebf326c21f231b0647ab87f
+  data.tar.gz: '08487047b88927433c1e02be1e91b9ff9d98aa138f28fdbbe93c3c85e2e2729d9635c6622224745a295faf2a693d3a5ffb8051facbd221bb9ae3be0064fd9a44'

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/