Skip to content

Commit

Permalink
Add note to README
Browse files Browse the repository at this point in the history
  • Loading branch information
razor-x committed Jan 11, 2024
1 parent e1f1ce4 commit 97d15d2
Showing 1 changed file with 13 additions and 3 deletions.
16 changes: 13 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@

JavaScript SDK for the Seam API written in TypeScript.

_This is a preview of the next major version of the Seam SDK.
This SDK is available for early preview.
It will eventually replace the [seamapi](https://github.com/seamapi/javascript/) package._

## Description

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

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

- [`@seamapi/types`](https://github.com/seamapi/types): TypeScript types for the Seam API.
- [`@seamapi/http`](https://github.com/seamapi/javascript-http): JavaScript HTTP client for the Seam API written in TypeScript.
- [`@seamapi/webhook`](https://github.com/seamapi/javascript-http): Webhook SDK for the Seam API written in TypeScript.
- [@seamapi/types]: TypeScript types for the Seam API.
- [@seamapi/http]: JavaScript HTTP client for the Seam API written in TypeScript.
- [@seamapi/webhook]: Webhook SDK for the Seam API written in TypeScript.

[Seam]: https://www.seam.co/
[Seam Docs]: https://docs.seam.co/latest/
[@seamapi/types]: https://github.com/seamapi/types
[@seamapi/http]: https://github.com/seamapi/javascript-http
[@seamapi/webhook]: https://github.com/seamapi/javascript-webhook

## Installation

Expand Down

0 comments on commit 97d15d2

Please sign in to comment.