octicons_helper 0.0.0.pre.5a55ef8 → 0.0.0.pre.5ab3fff

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3174a14885be7993f761ab19395d4e6de171c26e320986741a8037087968eda
-  data.tar.gz: 0a35f38c74cab5d95e74e514ef7a1d30ef86008111daa332caacea3f1d496eb5
+  metadata.gz: 1166653ac4bcad455a8a535b660d1ed9de428fc13c909ecda06f1300638249bd
+  data.tar.gz: 17896c4a3fa27d2b89411c730f4bd85d81f76fd7f514c0ccd080258ae0eabdda
 SHA512:
-  metadata.gz: 6fdc683356b7897019003ef5c2d3c80fdeea933467b416c44a87411e3d26d1d3312146bca1302654091240d74c119ed3c40c0527ea1cadf258432a2ba54a5f05
-  data.tar.gz: 306c14b13f17bae67fa8bf442952f4e33c2d2d6ce7f0ffe41b6a47dfb8a33c98f23d1790ff984263a1edf7f9459f78cac66def10a126698e99c465429f4bd6c4
+  metadata.gz: dccd3c54a8177dcc103295f02df5a95ae4133729d5f01e4c6402cb26374281f48b62f6651cd9a17fc9c49a08e3d52e27b47716c79a981d59abda13a74883fbc8
+  data.tar.gz: 9617a5038d444b74f5ed5cae321d5ac1e62510521c1aff2110efdac683dd0aa4657d94b77fbf75aa5d6f9e48c76811fdf75ce832a08c4ee3af5b9b94dcacf31a

data/LICENSE

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