Skip to content

Commit

Permalink
fix: rename back to atem-connection
Browse files Browse the repository at this point in the history
Business descision to call the library atem-connection, not
tv-automation-atem-connection.
  • Loading branch information
stephan-nordnes-eriksen committed Jun 5, 2018
1 parent a57299e commit e1b3e63
Show file tree
Hide file tree
Showing 3 changed files with 179 additions and 16 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ _Note: this is a work in progress, expect many new features and also... breaking

For usage by library consumers installation is as easy as:
```sh
yarn install git+https://github.com/nrkno/tv-automation-atem-connection
yarn add atem-connection
```

For library developers installation steps are as following:
Expand All @@ -31,7 +31,7 @@ If you want to make a contribution, feel free to open a PR.
## Usage

```javascript
const { Atem } = require('tv-automation-atem-connection')
const { Atem } = require('atem-connection')
const myAtem = new Atem({ externalLog: console.log })

myAtem.connect('192.168.168.240')
Expand Down
18 changes: 11 additions & 7 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "tv-automation-atem-connection",
"name": "atem-connection",
"version": "0.0.0",
"description": "Typescript Node.js library for connecting with an ATEM switcher.",
"main": "dist/index.js",
Expand All @@ -26,23 +26,26 @@
],
"scripts": {
"info": "npm-scripts-info",
"build": "trash dist && tsc -p tsconfig.json",
"build": "trash dist && yarn build:main",
"build:main": "tsc -p tsconfig.json",
"lint": "tslint --project tsconfig.jest.json --config tslint.json",
"unit": "jest",
"unit": "jest --forceExit",
"test": "yarn lint && yarn unit",
"watch": "jest --watch",
"cov": "jest; opn coverage/lcov-report/index.html",
"cov": "jest --coverage; opn coverage/lcov-report/index.html",
"cov-open": "opn coverage/lcov-report/index.html",
"send-coverage": "jest && codecov",
"docs": "yarn docs:html && opn docs/index.html",
"docs:test": "yarn docs:html",
"docs:html": "typedoc src/index.ts --excludePrivate --mode file --theme minimal --out docs",
"docs:json": "typedoc --mode file --json docs/typedoc.json src/index.ts",
"docs:publish": "yarn docs:html && echo \"gh-pages -d docs. DO THIS IN THE FUTURE\"",
"docs:publish": "yarn docs:html && gh-pages -d docs",
"changelog": "standard-version",
"release": "yarn reset && yarn test && yarn docs:publish && yarn changelog",
"reset": "git clean -dfx && git reset --hard && yarn",
"ci": "yarn test",
"validate:dependencies": "nsp check"
"ci": "yarn test && yarn docs:test",
"validate:dependencies": "nsp check && yarn license-validate",
"license-validate": "node-license-validator -p -d --allow-licenses MIT BSD BSD-3-Clause ISC Apache"
},
"scripts-info": {
"info": "Display information about the scripts",
Expand Down Expand Up @@ -74,6 +77,7 @@
"gh-pages": "^1.0.0",
"jest": "^22.4.2",
"mkdirp": "^0.5.1",
"node-license-validator": "^1.3.0",
"npm-scripts-info": "^0.3.6",
"nsp": "^3.2.1",
"nyc": "^11.0.3",
Expand Down
Loading

0 comments on commit e1b3e63

Please sign in to comment.