oceanprotocol
/
art
mirror of https://github.com/oceanprotocol/art
1
0
Fork 0
Code Releases Activity

make it an npm package

This commit is contained in:
Matthias Kretschmann 2018-06-04 17:16:22 +02:00
parent e44dc49d1a
commit 696ef9104b
Signed by: m
GPG Key ID: 606EEEF3C479A91F
3 changed files with 39 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
.gitignore vendored Normal file
View File

@ -0,0 +1,3 @@
node_modules
package-lock.json
yarn.lock

12
README.md
View File

@ -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

25
package.json Normal file
View File

@ -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 <matthias@bigchaindb.com>",
"license": "CC-BY-SA-4.0",
"bugs": {
"url": "https://github.com/oceanprotocol/art/issues"
},
"homepage": "https://oceanprotocol.com",
"devDependencies": {
"release-it": "^7.4.6"
}
}