octicons 0.0.0.pre.ba54359 → 0.0.0.pre.bae0c9e

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d30c067f5c62b9e06e3499e45d3de45a72fd03754ac4bafa5f5a7776342e5691
-  data.tar.gz: f3535b11a22d7209a119482648754e56e6ca716cde15af91e5888188863fa5af
+  metadata.gz: acad56b7727de5f7ff8239aff58ae6d129777d624bd19648567da5bdb367b759
+  data.tar.gz: f649d1337d41c59d94d27a5a5bab5c406ed504db6df720cea816320b6ba36590
 SHA512:
-  metadata.gz: e30d81b6d23a72e3907041c7815c585ca14850be5d928d3e69b07b806c8e94d2381e8e87745a96ebb406157a49693059f3d8ddc1be6ba4b21dbd3a5977294a76
-  data.tar.gz: df8b9f8613be7d21ef358e4faa7799a4ae55cb7df092ff80bbdbc705b2a3c354cf959aecdf71dc6422c1c16106ccb093cd50bf3c38893fe2a6594a52f3902162
+  metadata.gz: 772121fd010c8ac2908484f5f40bc6cef59c23e8f411d25b07d044b238c6a4f8c9524a008c059b7fa6deb22fa52db5ba21cac7ad89b1e2378bff951100e0f3aa
+  data.tar.gz: 98bf5a252c9f2f8332f20538d657af0c4c96580dda6e81f591a2dd3ad41e5b9ea1a656843faca050965e5c7ffbf824caf1beb506a1f19ea337e54649cfd66427

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