octicons 17.12.0 → 18.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 39a1c885fe2694769ac98aed7ff89be8105e7a9b68084043102777237fcc4959
-  data.tar.gz: 46217072555283ca6c7fbd657997a296b2a5e5291b6492549cbaaf5edcb333fc
+  metadata.gz: bc68ffeef66286d0987ebc17f5d4518be09a1d3235662b10d4099c2f1428d3b6
+  data.tar.gz: e510e50cd05d3cf017e537af2859cf5ea7097e95c93cfdc1be97aad33393d878
 SHA512:
-  metadata.gz: 7227121643130069822f8886bce05f9aef995e0cd47178ab13771ab3be7801f40ceec5167d96e90eb72e0b274ffd4ed532f02170d6c4e26565efb00e17b5fd9a
-  data.tar.gz: 1fd4c546ec2a9fe880c0a1c7931c70b2a85f31d8457afa4cb38e503725fdcb71942fc80642e875f36db59cf81228cb6a712214c6c8744c663287bcccefc2c0dc
+  metadata.gz: a6b5a0585fb05fa7e6d0c180651646a44161f8547748f769beb4dc6c3a3ce0ea13258d79bc44008240a6e9c65f5aa94cfe2d2701d9f2b5fa6fdaf277bf1f8064
+  data.tar.gz: e3ed4c9bf98105b6a6f54aef8a17f869fd82c288a8a49177a9f40e161abef6ff61a37f6161c1d31fc360ef62493d6f97f99088bed2e5d95c5680e9873b98fead

data/README.md

@@ -2,4 +2,102 @@
 
 [![Gem version](https://img.shields.io/gem/v/octicons.svg)](https://rubygems.org/gems/octicons)
 
-See https://primer.style/octicons/packages/ruby
+## Install
+
+Add this to your `Gemfile`
+
+```rb
+gem 'octicons'
+```
+
+Then `bundle install`.
+
+If using a framework like Rails, please follow the [installation instructions](https://primer.style/view-components/#installation) in the [Primer ViewComponents](https://primer.style/view-components) documentation. 
+
+## 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](/)
+
+### 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>
+```