From 45ad431a436d909052b37d49584372c0e5a060ae Mon Sep 17 00:00:00 2001 From: birjolaxew Date: Sun, 17 Sep 2017 03:54:54 +0200 Subject: [PATCH] Update README for NPM publish --- README.md | 32 ++++++++++++++++++++++++++++---- 1 file changed, 28 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index c422f85bc..49d01be0a 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,32 @@ # Simple Icons -Free SVG icons for popular brands, started by [Dan Leech](https://twitter.com/bathtype). [See them all on one page at **simpleicons.org**](https://simpleicons.org). Contributions, corrections & requests can be made on GitHub. +Free SVG icons for popular brands, started by [Dan Leech](https://twitter.com/bathtype). [See them all on one page at **simpleicons.org**](https://simpleicons.org). Contributions, corrections & requests can be made on GitHub. -## To do +## Usage -- [ ] Analytics tracking for icon clicks -- [ ] New README.md +Icons can be downloaded as SVGs directly from [our website](https://simpleicons.org/) - simply click the icon you want, and the download should start automatically. + +### Node Usage + +The icons are also available through our npm package. To install, simply run: + +``` +$ npm install simple-icons +``` + +The API can then be used as follows: + +``` +const simpleIcons = require('simple-icons'); + +console.log(simpleIcons['Google+']); + +/* +{ + title: 'Google+', + hex: 'DC4E41', + source: 'https://developers.google.com/+/branding-guidelines', + svg: '...' +} +*/ +```