Skip to content

Commit

Permalink
Deprecate package in favor of octiconssvg.
Browse files Browse the repository at this point in the history
GitHub has deprecated the icon font version of Octicons in favor of
SVG. See primer/octicons#108, and
https://github.com/blog/2112-delivering-octicons-with-svg for
motivation.

Package github.com/shurcooL/octiconssvg should be used instead, which
provides Octicons in SVG format.
  • Loading branch information
dmitshur committed Jan 21, 2017
1 parent c6ddc68 commit 101c55d
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 3 deletions.
6 changes: 3 additions & 3 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
sudo: false
language: go
go:
- 1.7
- tip
- 1.x
- master
matrix:
allow_failures:
- go: tip
- go: master
fast_finish: true
install:
- # Do nothing. This is needed to prevent default install action "go get -t -v ./..." from happening here (we want it to happen inside script step).
Expand Down
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ Package octicons provides GitHub Octicons.

It's a Go package that statically embeds GitHub Octicons data, exposing it via an http.FileSystem.

Deprecated: GitHub has deprecated the icon font version of Octicons in favor of SVG.
See https://github.com/primer/octicons/issues/108 and https://github.com/blog/2112-delivering-octicons-with-svg.
Use github.com/shurcooL/octiconssvg instead, which provides Octicons in SVG format.

Installation
------------

Expand Down
4 changes: 4 additions & 0 deletions doc.go
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
// Package octicons provides GitHub Octicons.
//
// It's a Go package that statically embeds GitHub Octicons data, exposing it via an http.FileSystem.
//
// Deprecated: GitHub has deprecated the icon font version of Octicons in favor of SVG.
// See https://github.com/primer/octicons/issues/108 and https://github.com/blog/2112-delivering-octicons-with-svg.
// Use github.com/shurcooL/octiconssvg instead, which provides Octicons in SVG format.
package octicons

//go:generate curl -L -o octicons.zip https://github.com/primer/octicons/archive/v4.3.0.zip
Expand Down

0 comments on commit 101c55d

Please sign in to comment.