octicons_v2 0.0.0.pre.d793318 → 0.0.0.pre.dcc6a36

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c541b3d16841b1bcee19d0e87b90ef6e01d3bc1a4f34a2ccdb1b6f1208dcda1
-  data.tar.gz: '089ecd18189b4bb98f39a4ea7001d2ab1a2e82703a4ed89d9e31909bb120d72f'
+  metadata.gz: a3ce4c357433a52a47ec5aaba8e3b0ba3d71362684bc64d0a60450e23e602a9c
+  data.tar.gz: d746e855be86a1ace1f066e3c59e38d93464558b5d45aadf11d71ca0eabfc581
 SHA512:
-  metadata.gz: 1da4a6f6412fe7b5be30cfc922c7b4b163993a88b7fccba7c581bdb454f55603f9bffb042961f210eebb9a5c9e230bc6c65f96f4b827ffe1ebe26b2e025c29f3
-  data.tar.gz: d954e9f87ae24cf4623253031194a9ed17adbadf54ae1ebbc3bcba8f2aadb075af42b66f9749f3e057a4264d2c18fa9376121adcd8fdd1112e9bbdb7f5506c65
+  metadata.gz: accabdd423ce090b80c88c7fbf386c9f4009a0721a76a856b5055dca7f902d2840595aee6deb807b122b05af5e6ed97535507659c64463a613ae88097e18ad1b
+  data.tar.gz: 8426fb2f93e2dc843fa2c2a75fd24b0942d1a5e2f0c39d85e81d5fd3b725fc26e9a03ca4a0e0291135ca19eb0d9d05e7f2b3dd9cad8c38a4f895cafc9c2530ce

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