From 696ef9104b7c3e00493ce78b566aad0b3566d2b9 Mon Sep 17 00:00:00 2001 From: Matthias Kretschmann Date: Mon, 4 Jun 2018 17:16:22 +0200 Subject: [PATCH] make it an npm package --- .gitignore | 3 +++ README.md | 12 +++++++++++- package.json | 25 +++++++++++++++++++++++++ 3 files changed, 39 insertions(+), 1 deletion(-) create mode 100644 .gitignore create mode 100644 package.json diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..960be9a --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +node_modules +package-lock.json +yarn.lock \ No newline at end of file diff --git a/README.md b/README.md index a99585d..0f765c5 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,8 @@ > 🐳 Ocean Protocol's assets for community distribution. +[![npm](https://img.shields.io/npm/v/oceanprotocol-art.svg)](https://www.npmjs.com/package/oceanprotocol-art) + All assets in this repo can also be viewed and downloaded from [oceanprotocol.com/art](https://oceanprotocol.com/art). You'll find a living styleguide there too. ## Repository Contents @@ -21,7 +23,15 @@ If you only need them for use on the web, you can grab them from inside the priv ## Usage -It's encouraged to use this repo as a submodule within your projects to keep the assets in sync. From the root of your project folder execute the following to put the submodule under `lib/art/`: +It's encouraged to use this repo as a dependency within your projects to keep the assets in sync. The whole repo is published as a npm module so just run for installation: + +```bash +npm install oceanprotocol-art +``` + +### Use as a submodule + + From the root of your project folder execute the following to put the submodule under `lib/art/`: ```bash git submodule add git@github.com:oceanprotocol/art.git lib/art diff --git a/package.json b/package.json new file mode 100644 index 0000000..a4ea65a --- /dev/null +++ b/package.json @@ -0,0 +1,25 @@ +{ + "name": "oceanprotocol-art", + "version": "0.9.0", + "description": "Ocean Protocol's assets for community distribution.", + "main": "index.js", + "scripts": { + "test": "echo \"Error: no test specified\" && exit 1", + "release": "./node_modules/release-it/bin/release-it.js --src.tagName='v%s' --github.release --npm.publish --non-interactive", + "release-minor": "./node_modules/release-it/bin/release-it.js minor --src.tagName='v%s' --github.release --npm.publish --non-interactive", + "release-major": "./node_modules/release-it/bin/release-it.js major --src.tagName='v%s' --github.release --npm.publish --non-interactive" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/oceanprotocol/art.git" + }, + "author": "Matthias Kretschmann ", + "license": "CC-BY-SA-4.0", + "bugs": { + "url": "https://github.com/oceanprotocol/art/issues" + }, + "homepage": "https://oceanprotocol.com", + "devDependencies": { + "release-it": "^7.4.6" + } +}