diff --git a/.npmignore b/.npmignore new file mode 100644 index 00000000..c1219e73 --- /dev/null +++ b/.npmignore @@ -0,0 +1,2 @@ +* +!icons diff --git a/README.md b/README.md index 307f9761..376c94b8 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,19 @@ ## Basic Usage -You can download any icon of the pack directly from https://iconoir.com or get them from the repository. +You can download any icon of the pack directly from https://iconoir.com or get them from this repository. + +Additionally, the icons are available via the `iconoir` NPM package: +```bash +yarn add iconoir +# or +npm i iconoir +``` + +Example usage: +```js +import Iconoir from 'iconoir/icons/iconoir.svg' +``` ## React diff --git a/package.json b/package.json index e4582885..a0e3780f 100644 --- a/package.json +++ b/package.json @@ -1,10 +1,28 @@ { "name": "iconoir", - "private": true, + "version": "1.0.0", + "description": "A Simple and Definitive Open-Source Icons Library", "type": "module", + "files": [ + "icons" + ], "scripts": { "build": "node ./bin/build.js" }, + "repository": { + "type": "git", + "url": "git+https://github.com/lucaburgio/iconoir.git" + }, + "keywords": [ + "icons", + "svg", + "library" + ], + "license": "MIT", + "bugs": { + "url": "https://github.com/lucaburgio/iconoir/issues" + }, + "homepage": "https://iconoir.com", "devDependencies": { "@svgr/cli": "^5.5.0", "execa": "^5.1.1", diff --git a/packages/iconoir-react-native/package.json b/packages/iconoir-react-native/package.json index 9ffb6790..e3490c40 100644 --- a/packages/iconoir-react-native/package.json +++ b/packages/iconoir-react-native/package.json @@ -18,14 +18,15 @@ "keywords": [ "icons", "svg", - "library" + "library", + "react-native" ], "license": "MIT", "bugs": { "url": "https://github.com/lucaburgio/iconoir/issues" }, "sideEffects": false, - "homepage": "https://github.com/lucaburgio/iconoir#readme", + "homepage": "https://iconoir.com", "peerDependencies": { "react": "^16.8.6 || ^17", "react-native": ">=0.50.0", diff --git a/packages/iconoir-react/package.json b/packages/iconoir-react/package.json index 75a2aa59..3a9dc724 100644 --- a/packages/iconoir-react/package.json +++ b/packages/iconoir-react/package.json @@ -18,14 +18,15 @@ "keywords": [ "icons", "svg", - "library" + "library", + "react" ], "license": "MIT", "bugs": { "url": "https://github.com/lucaburgio/iconoir/issues" }, "sideEffects": false, - "homepage": "https://github.com/lucaburgio/iconoir#readme", + "homepage": "https://iconoir.com", "peerDependencies": { "react": "^16.8.6 || ^17" },