web/simple-icons
1
0
Fork 0
mirror of https://github.com/simple-icons/simple-icons.git synced 2024-12-26 01:13:41 +02:00
Code Releases Activity

Merge pull request #537 from birjolaxew/feature/npm

Browse Source 
Prepare for NPM publishing
This commit is contained in:
Johan Fagerberg 2017-09-17 04:00:33 +02:00 committed by GitHub
commit fea7c9f4ac
4 changed files with 37 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
.npmignore
View File

@ -5,4 +5,5 @@
!icons/
!package.json
!README.md
!LICENSE.md
!LICENSE.md
!index.js

32
README.md
View File

@ -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:
```javascript
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>'
}
*/
```

11
example.js
View File

@ -1,11 +0,0 @@
const SimpleIcons = require('./');
console.log(SimpleIcons['500px'].svg);
/*
{ title: '500px',
hex: '0099E5',
source: 'https://about.500px.com/press',
name: '500px',
svg: '<svg aria-labelledby="simpleicons-500px-icon" role="img" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg">...</svg>' }
*/

12
index.js
View File

@ -2,12 +2,14 @@ const dataFile = './_data/simple-icons.json';
const data = require(dataFile);
const fs = require('fs');
let Icons = {};
const icons = {};
data.icons.forEach(i => {
i.name = i.title.toLowerCase().replace(/[^a-z0-9]/gim, '');
i.svg = fs.readFileSync(`./icons/${i.name}.svg`, 'utf8');
Icons[i.name] = i
const filename = i.title.toLowerCase()
.replace(/\+/g, "plus")
.replace(/[ .\-!’]/g, '');
i.svg = fs.readFileSync(`./icons/${filename}.svg`, 'utf8');
icons[i.title] = i
});
module.exports = Icons;
module.exports = icons;