From 101c55d36c8d8317c9e7190daba3c86e53fd06ce Mon Sep 17 00:00:00 2001 From: Dmitri Shuralyov Date: Fri, 20 Jan 2017 20:01:21 -0500 Subject: [PATCH] Deprecate package in favor of octiconssvg. 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 for motivation. Package github.com/shurcooL/octiconssvg should be used instead, which provides Octicons in SVG format. --- .travis.yml | 6 +++--- README.md | 4 ++++ doc.go | 4 ++++ 3 files changed, 11 insertions(+), 3 deletions(-) diff --git a/.travis.yml b/.travis.yml index f51cf6a..93b1fcd 100644 --- a/.travis.yml +++ b/.travis.yml @@ -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). diff --git a/README.md b/README.md index dc5abd6..2ec192b 100644 --- a/README.md +++ b/README.md @@ -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 ------------ diff --git a/doc.go b/doc.go index 4461886..526a339 100644 --- a/doc.go +++ b/doc.go @@ -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