octicons_v2 0.0.0.pre.fc97238 → 0.0.0.pre.fcf1e9b

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa22a8087335bffcc1931c7e2b4599bec34aa4607b0548c88005da960e1b4be0
-  data.tar.gz: b2d3ad4ca706e3dc447e6efc1320fa1cf34e2863119fa3d0e35d50ba98d37048
+  metadata.gz: fced72f564e3962e0cfc28d578a9995f9457147e4866013c36614761ef2f92aa
+  data.tar.gz: 2973f98e27f60a135caecb31c14a147a347fc3b1b30b004aee9de0ac054467b9
 SHA512:
-  metadata.gz: bb8e5b3ee6698a5ab20f18d74b6b76cd20d3dfa4d842acd1c792c22bcfd58d5d327044cf45120ef8635996d9ffd0edf1f2ddacf79e6815ebd4062d1e5e0375a6
-  data.tar.gz: af3a3b5e07f7a70c91a7f7614ede414808a5f74bce6b09bcbcc976e5ea7aa3b3fad3e2b9408e4f8bb73c8f8192b878af98d233e0dcdcc247beca96718e361d1e
+  metadata.gz: 9457ec550e7ff53eb562d523446608b9f04867da20730d8d11cd10d1284a7a8af5823c395e1d2be123cd99d517745b3b5a0212be0d0aca5aa6019367018990d9
+  data.tar.gz: 412881870d997ad9b2fc84372c81f534c21ae7ae2b9a4dfa7dd8cba829a3f862433301f5364eeda52870f32f3119fe8018f12c0cea003b158e68d55d92b2b911

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/