From 1a7d89de1de469c759e28e44a402ede0e6f8d938 Mon Sep 17 00:00:00 2001 From: Sindre Sorhus Date: Mon, 25 Jun 2018 14:35:58 +0700 Subject: [PATCH] Prepare for publish to npm --- .gitignore | 2 +- Coin List.md | 2 +- README.md | 16 +++++++- package.json | 111 +++++++++++++++++++++++++++++---------------------- 4 files changed, 80 insertions(+), 51 deletions(-) diff --git a/.gitignore b/.gitignore index 6276a62c..c406da79 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,3 @@ node_modules yarn.lock -build +dist diff --git a/Coin List.md b/Coin List.md index 8c7dd0e1..a7698e9d 100644 --- a/Coin List.md +++ b/Coin List.md @@ -1,6 +1,6 @@ # Coin List -###### As of 25 June 2018 — [http://cryptoicons.co](http://cryptoicons.co) +###### As of 2018-06-25 — [http://cryptoicons.co](http://cryptoicons.co) Symbol | Name ---------|--------- diff --git a/README.md b/README.md index 3ebca6a8..c4a96f6f 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,14 @@ Images are in the PNG format (transparent) in 32×32, 64×64(@2x), and 128×128 If there is an altcoin you’re looking for that hasn’t been included, please create a new issue. +## Install 🚀 + +``` +$ npm install cryptocurrency-icons +``` + +You then import or get the icons from their relative path, for example `./node_modules/dist/svg/color/kmd.svg`. + ## Contribute ❤️ [Here](https://github.com/hyperdexapp/cryptocurrency-icons/wiki) you can find a loose guide, as well as a link to the template used to create icons for this project. @@ -14,11 +22,15 @@ If there is an altcoin you’re looking for that hasn’t been included, please The build system requires node and npm to be installed on your system. After they are installed you can install the npm dependencies with - npm install +``` +$ npm install +``` You can then build with - npm run build +``` +$ npm run build +``` ## License 📄 diff --git a/package.json b/package.json index 101ec8b7..691a3f47 100644 --- a/package.json +++ b/package.json @@ -10,59 +10,76 @@ "url": "https://github.com/cjdowner" }, "scripts": { - "minify-images:32:black": "imagemin '32/black/*' --out-dir='build/32/black'", - "minify-images:32:color": "imagemin '32/color/*' --out-dir='build/32/color'", - "minify-images:32:icon": "imagemin '32/icon/*' --out-dir='build/32/icon'", - "minify-images:32:white": "imagemin '32/white/*' --out-dir='build/32/white'", + "minify-images:32:black": "imagemin '32/black/*' --out-dir='dist/32/black'", + "minify-images:32:color": "imagemin '32/color/*' --out-dir='dist/32/color'", + "minify-images:32:icon": "imagemin '32/icon/*' --out-dir='dist/32/icon'", + "minify-images:32:white": "imagemin '32/white/*' --out-dir='dist/32/white'", "minify-images:32": "npm run minify-images:32:black && npm run minify-images:32:color && npm run minify-images:32:icon && npm run minify-images:32:white", - "minify-images:128:black": "imagemin '128/black/*' --out-dir='build/128/black'", - "minify-images:128:color": "imagemin '128/color/*' --out-dir='build/128/color'", - "minify-images:128:icon": "imagemin '128/icon/*' --out-dir='build/128/icon'", - "minify-images:128:white": "imagemin '128/white/*' --out-dir='build/128/white'", + "minify-images:32@2x:black": "imagemin '32@2x/black/*' --out-dir='dist/32@2x/black'", + "minify-images:32@2x:color": "imagemin '32@2x/color/*' --out-dir='dist/32@2x/color'", + "minify-images:32@2x:icon": "imagemin '32@2x/icon/*' --out-dir='dist/32@2x/icon'", + "minify-images:32@2x:white": "imagemin '32@2x/white/*' --out-dir='dist/32@2x/white'", + "minify-images:32@2x": "npm run minify-images:32@2x:black && npm run minify-images:32@2x:color && npm run minify-images:32@2x:icon && npm run minify-images:32@2x:white", + "minify-images:128:black": "imagemin '128/black/*' --out-dir='dist/128/black'", + "minify-images:128:color": "imagemin '128/color/*' --out-dir='dist/128/color'", + "minify-images:128:icon": "imagemin '128/icon/*' --out-dir='dist/128/icon'", + "minify-images:128:white": "imagemin '128/white/*' --out-dir='dist/128/white'", "minify-images:128": "npm run minify-images:128:black && npm run minify-images:128:color && npm run minify-images:128:icon && npm run minify-images:128:white", - "minify-images:svg:black": "imagemin 'svg/black/*' --out-dir='build/svg/black'", - "minify-images:svg:color": "imagemin 'svg/color/*' --out-dir='build/svg/color'", - "minify-images:svg:icon": "imagemin 'svg/icon/*' --out-dir='build/svg/icon'", - "minify-images:svg:white": "imagemin 'svg/white/*' --out-dir='build/svg/white'", + "minify-images:svg:black": "imagemin 'svg/black/*' --out-dir='dist/svg/black'", + "minify-images:svg:color": "imagemin 'svg/color/*' --out-dir='dist/svg/color'", + "minify-images:svg:icon": "imagemin 'svg/icon/*' --out-dir='dist/svg/icon'", + "minify-images:svg:white": "imagemin 'svg/white/*' --out-dir='dist/svg/white'", "minify-images:svg": "npm run minify-images:svg:black && npm run minify-images:svg:color && npm run minify-images:svg:icon && npm run minify-images:svg:white", - "minify-images": "npm run minify-images:32 && npm run minify-images:128 && npm run minify-images:svg", - "imacss:32:black": "mkdirp dist && imacss 'build/32/black/*' blank_option crypto-icon-32-black > build/32/black.css", - "imacss:32:color": "mkdirp dist && imacss 'build/32/color/*' blank_option crypto-icon-32-color > build/32/color.css", - "imacss:32:icon": "mkdirp dist && imacss 'build/32/icon/*' blank_option crypto-icon-32-icon > build/32/icon.css", - "imacss:32:white": "mkdirp dist && imacss 'build/32/white/*' blank_option crypto-icon-32-white > build/32/white.css", - "postimacss:32:black": "concat defaults.css build/32/black.css > dist/cryptocurrency-icons-32-black.css", - "postimacss:32:color": "concat defaults.css build/32/color.css > dist/cryptocurrency-icons-32-color.css", - "postimacss:32:icon": "concat defaults.css build/32/icon.css > dist/cryptocurrency-icons-32-icon.css", - "postimacss:32:white": "concat defaults.css build/32/white.css > dist/cryptocurrency-icons-32-white.css", + "minify-images": "npm run minify-images:32 && npm run minify-images:32@2x && npm run minify-images:128 && npm run minify-images:svg", + "imacss:32:black": "make-dir dist && imacss 'dist/32/black/*' blank_option crypto-icon-32-black > dist/32/black.css", + "imacss:32:color": "make-dir dist && imacss 'dist/32/color/*' blank_option crypto-icon-32-color > dist/32/color.css", + "imacss:32:icon": "make-dir dist && imacss 'dist/32/icon/*' blank_option crypto-icon-32-icon > dist/32/icon.css", + "imacss:32:white": "make-dir dist && imacss 'dist/32/white/*' blank_option crypto-icon-32-white > dist/32/white.css", + "postimacss:32:black": "concat defaults.css dist/32/black.css > dist/cryptocurrency-icons-32-black.css", + "postimacss:32:color": "concat defaults.css dist/32/color.css > dist/cryptocurrency-icons-32-color.css", + "postimacss:32:icon": "concat defaults.css dist/32/icon.css > dist/cryptocurrency-icons-32-icon.css", + "postimacss:32:white": "concat defaults.css dist/32/white.css > dist/cryptocurrency-icons-32-white.css", "imacss:32": "npm run imacss:32:black && npm run imacss:32:color && npm run imacss:32:icon && npm run imacss:32:white", - "imacss:128:black": "mkdirp dist && imacss 'build/128/black/*' blank_option crypto-icon-128-black > build/128/black.css", - "imacss:128:color": "mkdirp dist && imacss 'build/128/color/*' blank_option crypto-icon-128-color > build/128/color.css", - "imacss:128:icon": "mkdirp dist && imacss 'build/128/icon/*' blank_option crypto-icon-128-icon > build/128/icon.css", - "imacss:128:white": "mkdirp dist && imacss 'build/128/white/*' blank_option crypto-icon-128-white > build/128/white.css", - "postimacss:128:black": "concat defaults.css build/128/black.css > dist/cryptocurrency-icons-128-black.css", - "postimacss:128:color": "concat defaults.css build/128/color.css > dist/cryptocurrency-icons-128-color.css", - "postimacss:128:icon": "concat defaults.css build/128/icon.css > dist/cryptocurrency-icons-128-icon.css", - "postimacss:128:white": "concat defaults.css build/128/white.css > dist/cryptocurrency-icons-128-white.css", + "imacss:32@2x:black": "make-dir dist && imacss 'dist/32@2x/black/*' blank_option crypto-icon-32@2x-black > dist/32@2x/black.css", + "imacss:32@2x:color": "make-dir dist && imacss 'dist/32@2x/color/*' blank_option crypto-icon-32@2x-color > dist/32@2x/color.css", + "imacss:32@2x:icon": "make-dir dist && imacss 'dist/32@2x/icon/*' blank_option crypto-icon-32@2x-icon > dist/32@2x/icon.css", + "imacss:32@2x:white": "make-dir dist && imacss 'dist/32@2x/white/*' blank_option crypto-icon-32@2x-white > dist/32@2x/white.css", + "postimacss:32@2x:black": "concat defaults.css dist/32@2x/black.css > dist/cryptocurrency-icons-32@2x-black.css", + "postimacss:32@2x:color": "concat defaults.css dist/32@2x/color.css > dist/cryptocurrency-icons-32@2x-color.css", + "postimacss:32@2x:icon": "concat defaults.css dist/32@2x/icon.css > dist/cryptocurrency-icons-32@2x-icon.css", + "postimacss:32@2x:white": "concat defaults.css dist/32@2x/white.css > dist/cryptocurrency-icons-32@2x-white.css", + "imacss:32@2x": "npm run imacss:32@2x:black && npm run imacss:32@2x:color && npm run imacss:32@2x:icon && npm run imacss:32@2x:white", + "imacss:128:black": "make-dir dist && imacss 'dist/128/black/*' blank_option crypto-icon-128-black > dist/128/black.css", + "imacss:128:color": "make-dir dist && imacss 'dist/128/color/*' blank_option crypto-icon-128-color > dist/128/color.css", + "imacss:128:icon": "make-dir dist && imacss 'dist/128/icon/*' blank_option crypto-icon-128-icon > dist/128/icon.css", + "imacss:128:white": "make-dir dist && imacss 'dist/128/white/*' blank_option crypto-icon-128-white > dist/128/white.css", + "postimacss:128:black": "concat defaults.css dist/128/black.css > dist/cryptocurrency-icons-128-black.css", + "postimacss:128:color": "concat defaults.css dist/128/color.css > dist/cryptocurrency-icons-128-color.css", + "postimacss:128:icon": "concat defaults.css dist/128/icon.css > dist/cryptocurrency-icons-128-icon.css", + "postimacss:128:white": "concat defaults.css dist/128/white.css > dist/cryptocurrency-icons-128-white.css", "imacss:128": "npm run imacss:128:black && npm run imacss:128:color && npm run imacss:128:icon && npm run imacss:128:white", - "imacss:svg:black": "mkdirp dist && imacss 'build/svg/black/*' blank_option crypto-icon-svg-black > build/svg/black.css", - "imacss:svg:color": "mkdirp dist && imacss 'build/svg/color/*' blank_option crypto-icon-svg-color > build/svg/color.css", - "imacss:svg:icon": "mkdirp dist && imacss 'build/svg/icon/*' blank_option crypto-icon-svg-icon > build/svg/icon.css", - "imacss:svg:white": "mkdirp dist && imacss 'build/svg/white/*' blank_option crypto-icon-svg-white > build/svg/white.css", - "postimacss:svg:black": "concat defaults.css build/svg/black.css > dist/cryptocurrency-icons-svg-black.css", - "postimacss:svg:color": "concat defaults.css build/svg/color.css > dist/cryptocurrency-icons-svg-color.css", - "postimacss:svg:icon": "concat defaults.css build/svg/icon.css > dist/cryptocurrency-icons-svg-icon.css", - "postimacss:svg:white": "concat defaults.css build/svg/white.css > dist/cryptocurrency-icons-svg-white.css", + "imacss:svg:black": "make-dir dist && imacss 'dist/svg/black/*' blank_option crypto-icon-svg-black > dist/svg/black.css", + "imacss:svg:color": "make-dir dist && imacss 'dist/svg/color/*' blank_option crypto-icon-svg-color > dist/svg/color.css", + "imacss:svg:icon": "make-dir dist && imacss 'dist/svg/icon/*' blank_option crypto-icon-svg-icon > dist/svg/icon.css", + "imacss:svg:white": "make-dir dist && imacss 'dist/svg/white/*' blank_option crypto-icon-svg-white > dist/svg/white.css", + "postimacss:svg:black": "concat defaults.css dist/svg/black.css > dist/cryptocurrency-icons-svg-black.css", + "postimacss:svg:color": "concat defaults.css dist/svg/color.css > dist/cryptocurrency-icons-svg-color.css", + "postimacss:svg:icon": "concat defaults.css dist/svg/icon.css > dist/cryptocurrency-icons-svg-icon.css", + "postimacss:svg:white": "concat defaults.css dist/svg/white.css > dist/cryptocurrency-icons-svg-white.css", "imacss:svg": "npm run imacss:svg:black && npm run imacss:svg:color && npm run imacss:svg:icon && npm run imacss:svg:white", - "imacss": "npm run imacss:32 && npm run imacss:128 && npm run imacss:svg", - "svgstore:black": "mkdirp dist && svgstore -o dist/cryptocurrency-icons-black.svg build/svg/black/*.svg", - "svgstore:color": "mkdirp dist && svgstore -o dist/cryptocurrency-icons-color.svg build/svg/color/*.svg", - "svgstore:icon": "mkdirp dist && svgstore -o dist/cryptocurrency-icons-icon.svg build/svg/icon/*.svg", - "svgstore:white": "mkdirp dist && svgstore -o dist/cryptocurrency-icons-white.svg build/svg/white/*.svg", + "imacss": "npm run imacss:32 && npm run imacss:32@2x && npm run imacss:128 && npm run imacss:svg", + "svgstore:black": "make-dir dist && svgstore -o dist/cryptocurrency-icons-black.svg dist/svg/black/*.svg", + "svgstore:color": "make-dir dist && svgstore -o dist/cryptocurrency-icons-color.svg dist/svg/color/*.svg", + "svgstore:icon": "make-dir dist && svgstore -o dist/cryptocurrency-icons-icon.svg dist/svg/icon/*.svg", + "svgstore:white": "make-dir dist && svgstore -o dist/cryptocurrency-icons-white.svg dist/svg/white/*.svg", "svgstore": "npm run svgstore:black && npm run svgstore:color && npm run svgstore:icon && npm run svgstore:white", - "clean": "rimraf build && rimraf dist", - "build": "npm run minify-images && npm run imacss && npm run svgstore", - "prebuild": "npm run clean" + "clean": "del-cli dist", + "build": "npm run clean && npm run minify-images && npm run imacss && npm run svgstore", + "prepublish": "npm run build" }, + "files": [ + "dist" + ], "keywords": [ "cryptocurrency", "icons", @@ -90,10 +107,10 @@ ], "devDependencies": { "concat": "^1.0.3", + "del-cli": "^1.1.0", "imacss": "^1.0.0", "imagemin-cli": "^3.0.0", - "mkdirp": "^0.5.1", - "rimraf": "^2.6.2", + "make-dir-cli": "^1.0.0", "svgstore-cli": "^1.3.1" } }