octicons 0.0.0.pre.3c6f57b → 0.0.0.pre.3c65f8d

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34abaf9f52a4215ba556778ee0643fb9f3fe2da5b009690a334952ef52ba2f0e
-  data.tar.gz: 0ef963d7921f25488d91f2909d62c97c3f042ac9cb4e9981eb9ef485c8492cf4
+  metadata.gz: a6a474ada244ebf36cee39c3a254333ef2e3036e0d16755a64aa390ec987ea65
+  data.tar.gz: 38dc3087856624c1d86d7c8ad6681b3870d188bbb50c856a63b43988e713aa5f
 SHA512:
-  metadata.gz: 59bbdbe16415d3af333c0afd515cf5ec5de4cf595297bad295b8b8f4a4d76c38554d1018d28a9b8c483b3bd88b6092173e1947708841c0453d0dd29085fa7acd
-  data.tar.gz: cfbf83ba4ab9d047c65cacc16ba1924bb82d72c000dbca1ad23fc85bd42a913d898424bc1e5a959a374fe4d5aaf2082ae029b006eb3432e727e6f9028f70ab6d
+  metadata.gz: dd5c1ea9c7483e3f89e24b9d4a97ffb2726821a18d7d5d6873024cee3682c5edbffa7d89fe10599e07de49190ab988f519b1d1c0122388650ed76df5748785bd
+  data.tar.gz: bbe3866ce686eec5291e332e99e6c0bd6a7d059041a3fea3bee8babb396b698a8c6b3faeb54671e2087e50f7bfed066c0dad882f3b2bba086c7acbf93d1b5ccb

data/README.md

@@ -1,5 +1,119 @@
-# octicons 
+# Octicons gem
 
 [![Gem version](https://img.shields.io/gem/v/octicons.svg)](https://rubygems.org/gems/octicons)
+[![Build Status](https://travis-ci.org/primer/octicons.svg?branch=master)](https://travis-ci.org/primer/octicons)
 
-See https://primer.style/octicons/packages/ruby
+> Octicons gem to distribute octicons svg
+
+## Install
+
+Add this to your `Gemfile`
+
+```rb
+gem 'octicons'
+```
+
+Then `bundle install`.
+
+## Usage
+
+```rb
+require 'octicons'
+icon = Octicons::Octicon.new("x")
+icon.to_svg
+# <svg class="octicon octicon-x" viewBox="0 0 16 16" width="16" height="16" version="1.1" "aria-hidden"="true"><path d="M7.48 8l3.75 3.75-1.48 1.48L6 9.48l-3.75 3.75-1.48-1.48L4.52 8 .77 4.25l1.48-1.48L6 6.52l3.75-3.75 1.48 1.48z"></path></svg>
+```
+
+## Documentation
+
+The `Octicon` class takes two arguments. The first is the symbol of the icon, and the second is a hash of arguments representing html attributes
+
+#### `symbol` _(required)_
+
+This is the name of the octicon you want to use. For example `alert`. [Full list of icons][octicons-docs]
+
+#### Options
+
+* `:height` - When setting the height to a number, the icon will scale to that size. For example, passing `32`, will calculate the width based on the icon's natural size.
+* `:width` - When setting the width to a number, the icon will scale to that size. For example, passing `32`, will calculate the width based on the icon's natural size.
+
+If both `:width, :height` are passed into the options hash, then the icon will be sized exactly at those dimensions.
+
+#### Attributes
+
+Once initialized, you can read a few properties from the icon.
+
+##### `symbol`
+
+Returns the string of the symbol name
+
+```rb
+icon = Octicons::Octicon.new("x")
+icon.symbol
+# "x"
+```
+
+##### `path`
+
+Path returns the string representation of the path of the icon.
+
+```rb
+icon = Octicons::Octicon.new("x")
+icon.path
+# <path d="M7.48 8l3.75 3.75-1.48 1.48L6 9.48l-3.75 3.75-1.48-1.48L4.52 8 .77 4.25l1.48-1.48L6 6.52l3.75-3.75 1.48 1.48z"></path>
+```
+
+##### `options`
+
+This is a hash of all the `options` that will be added to the output tag.
+
+```rb
+icon = Octicons::Octicon.new("x")
+icon.options
+# {:class=>"octicon octicon-x", :viewBox=>"0 0 12 16", :version=>"1.1", :width=>12, :height=>16, :"aria-hidden"=>"true"}
+```
+
+##### `width`
+
+Width is the icon's true width. Based on the svg view box width. _Note, this doesn't change if you scale it up with size options, it only is the natural width of the icon_
+
+##### `height`
+
+Height is the icon's true height. Based on the svg view box height. _Note, this doesn't change if you scale it up with size options, it only is the natural height of the icon_
+
+##### `keywords`
+
+Returns an array of keywords for the icon. The data comes from the [data file in lib](../data.json). Consider contributing more aliases for the icons.
+
+```rb
+icon = Octicons::Octicon.new("x")
+icon.keywords
+# ["remove", "close", "delete"]
+```
+
+#### Methods
+
+##### `to_svg`
+
+Returns a string of the svg tag
+
+```rb
+icon = Octicons::Octicon.new("x")
+icon.to_svg
+# <svg class="octicon octicon-x" viewBox="0 0 16 16" width="16" height="16" version="1.1" "aria-hidden"="true"><path d="M7.48 8l3.75 3.75-1.48 1.48L6 9.48l-3.75 3.75-1.48-1.48L4.52 8 .77 4.25l1.48-1.48L6 6.52l3.75-3.75 1.48 1.48z"></path></svg>
+```
+
+## 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/