RikSolo/ts-osc
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

readme updates

Browse source
This commit is contained in:
Rik Berkelder 2021-01-23 20:30:54 +01:00
parent 6cf089ac68
commit ee66b16be2
2 changed files with 12 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

9
README.md
View file

@ -19,3 +19,12 @@ client.on('message', (msg)=>{
console.log(msg); console.log(msg);
}) })
``` ```
## NPM Scripts
| Tasks | Description |
| --------------------- | --------------------------------- |
| npm run build | Build module & docs |
| npm run compile | Compile TS |
| npm run watch | Compile and watch |
| npm run clean | Clean build folder |
| npm run docs | generate docs |

7
package.json
View file

@ -1,6 +1,6 @@
{ {
"name": "ts-osc", "name": "ts-osc",
"version": "0.1.1", "version": "0.1.2",
"description": "Fully TypeScript-native OSC Client based on osc-min", "description": "Fully TypeScript-native OSC Client based on osc-min",
"main": "./lib/index.js", "main": "./lib/index.js",
"types": "./lib/index.d.ts", "types": "./lib/index.d.ts",
@ -9,13 +9,12 @@
"compile": "tsc", "compile": "tsc",
"watch": "tsc --watch", "watch": "tsc --watch",
"docs": "typedoc --out docs ./src/index.ts", "docs": "typedoc --out docs ./src/index.ts",
"nojekyll": "touch ./docs/.nojekyll",
"clean": "rimraf lib", "clean": "rimraf lib",
"build": "run-s clean compile docs nojekyll" "build": "run-s clean compile docs"
}, },
"repository": { "repository": {
"type": "git", "type": "git",
"url": "ssh://git@gitlab.riksolo.com:2224/riksolo/ts-osc.git" "url": "https://gitlab.riksolo.com/riksolo/ts-osc/"
}, },
"keywords": [ "keywords": [
"osc", "osc",