Skip to content
This repository was archived by the owner on Nov 15, 2024. It is now read-only.

Commit ea93d6b

Browse files
committed
Update README
1 parent 2a8cc6d commit ea93d6b

File tree

2 files changed

+38
-2
lines changed

2 files changed

+38
-2
lines changed

README.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,28 @@
1-
# Javascript / Typescript Seam API Library
1+
# Javascript / Typescript Seam API Library & CLI
22

33
Control locks, lights and other internet of things devices with Seam's simple
44
API. Check out [the documentation](./docs/modules.md) or [some examples](./examples).
55

66
## Usage
77

8+
This package contains both a library and a CLI tool.
9+
10+
### CLI Usage
11+
12+
Install with `yarn global add seamapi` or `npm install -g seamapi`.
13+
14+
Then:
15+
```bash
16+
export SEAM_API_KEY=<your api key> # you can also pass this as an argument to the CLI
17+
18+
seam workspaces list
19+
```
20+
21+
### Library Usage
22+
23+
Install with `yarn add seamapi` or `npm install seamapi -s`.
24+
25+
Then:
826
```ts
927
// Replace with
1028
// const Seam = require("seamapi")

docs/README.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,30 @@
11
seamapi / [Exports](modules.md)
22

3-
# Javascript / Typescript Seam API Library
3+
# Javascript / Typescript Seam API Library & CLI
44

55
Control locks, lights and other internet of things devices with Seam's simple
66
API. Check out [the documentation](./docs/modules.md) or [some examples](./examples).
77

88
## Usage
99

10+
This package contains both a library and a CLI tool.
11+
12+
### CLI Usage
13+
14+
Install with `yarn global add seamapi` or `npm install -g seamapi`.
15+
16+
Then:
17+
```bash
18+
export SEAM_API_KEY=<your api key> # you can also pass this as an argument to the CLI
19+
20+
seam workspaces list
21+
```
22+
23+
### Library Usage
24+
25+
Install with `yarn add seamapi` or `npm install seamapi -s`.
26+
27+
Then:
1028
```ts
1129
// Replace with
1230
// const Seam = require("seamapi")

0 commit comments

Comments
 (0)