Skip to content

Commit 97d15d2

Browse files
committed
Add note to README
1 parent e1f1ce4 commit 97d15d2

1 file changed

Lines changed: 13 additions & 3 deletions

File tree

README.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@
55

66
JavaScript SDK for the Seam API written in TypeScript.
77

8+
_This is a preview of the next major version of the Seam SDK.
9+
This SDK is available for early preview.
10+
It will eventually replace the [seamapi](https://github.com/seamapi/javascript/) package._
11+
812
## Description
913

1014
[Seam] makes it easy to integrate IoT devices with your applications.
@@ -16,9 +20,15 @@ and optimized for use in both client and server applications.
1620

1721
The package does not contain any code, it re-exports from a core set of Seam modules:
1822

19-
- [`@seamapi/types`](https://github.com/seamapi/types): TypeScript types for the Seam API.
20-
- [`@seamapi/http`](https://github.com/seamapi/javascript-http): JavaScript HTTP client for the Seam API written in TypeScript.
21-
- [`@seamapi/webhook`](https://github.com/seamapi/javascript-http): Webhook SDK for the Seam API written in TypeScript.
23+
- [@seamapi/types]: TypeScript types for the Seam API.
24+
- [@seamapi/http]: JavaScript HTTP client for the Seam API written in TypeScript.
25+
- [@seamapi/webhook]: Webhook SDK for the Seam API written in TypeScript.
26+
27+
[Seam]: https://www.seam.co/
28+
[Seam Docs]: https://docs.seam.co/latest/
29+
[@seamapi/types]: https://github.com/seamapi/types
30+
[@seamapi/http]: https://github.com/seamapi/javascript-http
31+
[@seamapi/webhook]: https://github.com/seamapi/javascript-webhook
2232

2333
## Installation
2434

0 commit comments

Comments
 (0)