mirror of
				https://github.com/Mibew/simple-icons.git
				synced 2025-10-31 18:41:07 +03:00 
			
		
		
		
	Merge pull request #538 from simple-icons/develop
Merge NPM package into master
This commit is contained in:
		
						commit
						fcf9589be6
					
				| @ -5,4 +5,5 @@ | ||||
| !icons/ | ||||
| !package.json | ||||
| !README.md | ||||
| !LICENSE.md | ||||
| !LICENSE.md | ||||
| !index.js | ||||
|  | ||||
							
								
								
									
										32
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										32
									
								
								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: | ||||
| 
 | ||||
| ```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>' | ||||
| } | ||||
| */ | ||||
| ``` | ||||
|  | ||||
							
								
								
									
										15
									
								
								index.js
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										15
									
								
								index.js
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,15 @@ | ||||
| const dataFile = './_data/simple-icons.json'; | ||||
| const data = require(dataFile); | ||||
| const fs = require('fs'); | ||||
| 
 | ||||
| const icons = {}; | ||||
| 
 | ||||
| data.icons.forEach(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; | ||||
| @ -7,7 +7,7 @@ | ||||
|     "svg", | ||||
|     "icons" | ||||
|   ], | ||||
|   "main": "_data/simple-icons.json", | ||||
|   "main": "index.js", | ||||
|   "repository": "git@github.com:danleech/simple-icons.git", | ||||
|   "author": "Dan Leech", | ||||
|   "license": "CCO", | ||||
|  | ||||
		Loading…
	
		Reference in New Issue
	
	Block a user