Skip to content

Commit

Permalink
Update install instructions for beta.
Browse files Browse the repository at this point in the history
Move npm test & lint into prepublishOnly npm hook
  • Loading branch information
verkaufer committed Dec 1, 2020
1 parent abfe210 commit 4c903d4
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 4 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,12 @@ The library can be used by NodeJS applications, tools, and other automations to

## Installation

You can install the SDK using Git during the closed beta period:

```
npm install @1password/connect
npm install "git+ssh://[email protected]:1Password/connect-sdk-js.git#semver:~v0.0.1"
```
_`semvar:~v0.0.1` will ensure you install the latest pre-release build_

## Usage

This comment has been minimized.

Copy link
@carverc

carverc Oct 30, 2023

Ok


Expand All @@ -25,7 +28,7 @@ import {OnePasswordConnect, ItemBuilder} from "@1password/connect"
// Create new connector with HTTP Pooling
const op = OnePasswordConnect({
serverUrl: "http://localhost:8000",

This comment has been minimized.

Copy link
@carverc

carverc Oct 30, 2023

Done #105

token: "my-token" ,

This comment has been minimized.

Copy link
@carverc

carverc Oct 30, 2023

1

token: "my-token",

This comment has been minimized.

Copy link
@carverc

carverc Oct 30, 2023

package-lock.json`chancycarver

This comment has been minimized.

Copy link
@carverc

carverc Oct 30, 2023

Admin

[ ]

keepAlive: true
});
```
Expand Down
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@
"dist/"
],
"scripts": {
"prepare": "npm run test && npm run build",
"prepublishOnly": "npm run test && npm run lint",
"prepare": "npm run build",
"test": "jest",
"build": "tsc",
"lint": "eslint ./src --ext .ts"
Expand Down

0 comments on commit 4c903d4

Please sign in to comment.