Merge pull request #11 from primer/updating_octicons_5

Major updates for 3.0.0

CHANGELOG.md

@@ -1,5 +1,14 @@
 # HEAD
 
+# 3.0.0
+
+- Added: `to_svg_use` which will output a `<svg><use>` tag for svg spritesheets
+- Added: Ability to output the spritesheet with `Octicons.sprite_sheet`
+- Updating to new version of [octicons@5.0.0](https://github.com/primer/octicons/blob/master/CHANGELOG.md#500)
+- Removed: api endpoints for `decimal`, `hexadecimal`, and `character`
+- Removed: svg directory from `/lib/` this isn't necessary anymore with the updated `data.json` from 5.0.0
+- Removed: `Octicons::KEYWORDS` and `Octicons::CODEPOINTS`, Codepoints is deprecated and Keywords can be accessed via `Octicons::OCTICON_SYMBOLS`
+
 # 2.1.0
 
 - Updating to new version of [octicons@4.3.0](https://github.com/primer/octicons/blob/master/CHANGELOG.md#430)

Gemfile

@@ -2,8 +2,6 @@ source 'https://rubygems.org'
 
 gemspec
 
-gem 'nokogiri'
-
 group :development, :test do
   gem 'rake'
   gem 'minitest'

README.md

@@ -81,18 +81,6 @@ Width is the icon's true width. Based on the svg view box width. _Note, this doe
 
 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_
 
-#### 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>
-```
-
 ##### `keywords`
 
 Returns an array of keywords for the icon. The data [comes from the octicons repository](https://github.com/primer/octicons/blob/master/lib/keywords.json). Consider contributing more aliases for the icons.
@@ -103,34 +91,35 @@ icon.keywords
 # ["remove", "close", "delete"]
 ```
 
-##### `decimal`
+#### Methods
 
-Returns an `Integer` representing the codepoint of the character within the font file.
+##### `to_svg`
+
+Returns a string of the svg tag
 
 ```rb
-icon = Octicons::Octicon.new("alert")
-icon.decimal
-# 61485
+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>
 ```
 
-##### `hexadecimal`
+##### `to_svg_use`
 
-Returns an `String` representing the hexadecimal codepoint of the character within the font file.
+Returns a string of the svg tag
 
 ```rb
-icon = Octicons::Octicon.new("alert")
-icon.hexadecimal
-# "f02d"
+icon = Octicons::Octicon.new("x")
+icon.to_svg_use
+# <svg class="octicon octicon-x" viewBox="0 0 16 16" width="16" height="16" version="1.1" "aria-hidden"="true"><use xlink:href="#x" /></svg>
 ```
 
-##### `character`
+##### `sprite_sheet`
 
-Returns the unicode character of the icon. When placing this with the octicons font turned on, you'll see the icon.
+The Octicons class has a method that will output the svg sprite sheet that you can inline in your app.
 
 ```rb
-icon = Octicons::Octicon.new("alert")
-icon.character
-# ""
+Octicons.sprite_sheet
+# <svg xmlns="http://www.w3.org/2000/svg"><symbol viewBox="0 0 16 16" id="alert">...</svg>
 ```
 
 ## Publishing