octicons_v2 0.0.0.pre.6be9593 → 0.0.0.pre.6e304cc

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 622060732780be7216a9b12c6e0ef1523bf4d8db7ba06757a68101985319ccb3
-  data.tar.gz: eb74afb79aea2fdb40ee418e12ddfffce92ff90e4071bfd27c71d85e3b82c1a8
+  metadata.gz: da891e955c204f9192f910e9c0fd4f19eb1b75a0b87ceed5e9d8529b16071ed2
+  data.tar.gz: fd40cc34551b5d834621b7fbed6d5f672d7838c8530cd947f18af896d6094e2e
 SHA512:
-  metadata.gz: e3b9b9d81cae96e73dc5e18bc3336baa2aaa2853bbd680518ea934ea156f982b1a966c94713c850432c785304ffa31d8e4448212b65b4a769f5653ec68721a7b
-  data.tar.gz: 806534b1623de73e2b5d3c8a1dadc69303159374a6faa30c4ec0c3d8a0720256e2fd8ddc3474faccab758e42e48a0684163dd05dc6a8cef1874080b7038aa306
+  metadata.gz: 903d8e4f482449b2a055af0004b3fbb6a3a8bd79417d6adc85c8794f6e9591a181dd2f36187215f66ddeab69af687554fe65be1edd60646354cbf901a2b1bec4
+  data.tar.gz: a6889728bdeea474ea7cb22698ebeb38d1d6a80a3bf72613ca8a005b90780354893bff2ce00bd8481f3d0bd1f3b3a45176595a6dd337eef949c81c43af06f2cd

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/