octicons_v2 0.0.0.pre.79f685c → 0.0.0.pre.80aa871

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f2ce577689a4db6d814712ff9a78bf8bb75d2e35774996488218c703fe9b06a
-  data.tar.gz: 62f41a84ad8a7036431aa203ac52bb143af2a9d48d2af17cc325b8eb0f118209
+  metadata.gz: 2fcbea4ead48b800a833235fea6fa31feb9551a04be8e9ef59d8e62e723fe674
+  data.tar.gz: 74cb736d1ac5beaa952ecd75ee29937b28679125cdd80e0f2d0defc6818705ed
 SHA512:
-  metadata.gz: 2ab27a38852f55d4adc66d0ab49a9a9775495bab927137050666eaf20cd502bb893a01dae1bb4fe4280b07c8997fc92597d1229bb20c2b2496c64259bdc9eb23
-  data.tar.gz: 3f3785472f6f41d424a04734b8ccbf2fa700a775e6c1766124fd9e9235546727feef16d213b2e69d109d2192b59ccc00d896c3a44c8758549b2bf5587acbc75d
+  metadata.gz: 5f602347a1aa5d3532593bd4789b7aa0565f37c7d848c3db71ddac3af19dbe11660104a572fff9f7d789ffd6640b7f17f7caa3f848ee2e0ff09fc296684921e1
+  data.tar.gz: ab44f9792d1e2b94314b7e28f4f83c39d5fb7049f0357ec28b5635065e4e7501ada14678ea255bd3b06d3acd625c47ac9d971bf34314ebcb3b2049cd324ebb09

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