1
0
mirror of https://github.com/simple-icons/simple-icons.git synced 2024-11-16 00:59:07 +02:00
simple-icons/README.md

38 lines
1.2 KiB
Markdown
Raw Normal View History

2015-10-23 11:38:54 +02:00
# Simple Icons
2017-09-17 03:54:54 +02:00
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.
2017-04-23 17:55:38 +02:00
2017-09-17 03:54:54 +02:00
## Usage
2017-04-23 17:55:38 +02:00
2017-09-17 03:54:54 +02:00
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:
```javascript
2017-09-17 03:54:54 +02:00
const simpleIcons = require('simple-icons');
console.log(simpleIcons['Google+']);
/*
{
title: 'Google+',
hex: 'DC4E41',
source: 'https://developers.google.com/+/branding-guidelines',
svg: '<svg aria-labelledby="simpleicons-googleplus-icon" role="img" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg">...</svg>'
}
*/
```
2017-10-15 07:25:22 +02:00
## Status
[![Build Status](https://img.shields.io/travis/simple-icons/simple-icons/develop.svg)](https://travis-ci.org/simple-icons/simple-icons)
[![npm version](https://img.shields.io/npm/v/simple-icons.svg)](https://www.npmjs.com/package/simple-icons)