octicons_v2 0.0.0.pre.617ea40 → 0.0.0.pre.655bcdf

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff4acfe60c60d55bd0e296c8e0d36b7d30448903233603e48d6de4ad928ccae0
-  data.tar.gz: dcaeafd41bfc5e297f741e6823c6c5a337d9e3fd7355711735c36d8a7d84d940
+  metadata.gz: 3cfd9f0d6ce94a3c59007dadc4798c5f2ac43074548d55204d993d886f377e66
+  data.tar.gz: b2af8adf8f67fc8a6dbe6a6097cbe480a5d5c7a27915944cb73d0fda4716eed0
 SHA512:
-  metadata.gz: 3ac7c9e4e3d4cacd6896b4b2ef4f5d658f6f318f85fad527dc467c3fb7156492de447c7557ea962aabacd2a395fc19635d1964725e0bbf0d868f725f29b2335a
-  data.tar.gz: 180b4c9d47699fd27bf9e16ed542902ad7dabffce411b398d2870ab379722aabcf40139c816480ea9e4dbcd71a433fbcc69e7049e27e641cceca3ae4a83f3991
+  metadata.gz: 769ebf419bc81c0de4f01c2701790243926f75dbbb39cc1ec3303f76a4c33cc840562e5f0ec630d0cd2aa085c213f13cc4982c3faadc16df7be5ca5ed2df8205
+  data.tar.gz: 14cdbe2626445b499d497caad56637d6c7a1ed8222a0cee5bf000680b490dfbe61bca22d30d2a65418033ac9157a0130997631770d085ebc6d1109a33fec0881

data/README.md

@@ -1,119 +1,5 @@
-# Octicons gem
+# octicons 
 
 [![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)
 
-> 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/
+See https://primer.style/octicons/packages/ruby