@raindrop-ai/query 0.1.0 → 0.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +7 -43
- package/jsr.json +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,14 +1,9 @@
|
|
|
1
1
|
# @raindrop-ai/query
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Official TypeScript SDK for the [Raindrop Query API](https://query.raindrop.ai).
|
|
4
4
|
|
|
5
|
-
[![
|
|
6
|
-
[![
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
<br /><br />
|
|
10
|
-
> [!IMPORTANT]
|
|
11
|
-
> This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your [workspace](https://app.speakeasy.com/org/raindrop/query). Delete this section before > publishing to a package manager.
|
|
5
|
+
[](https://opensource.org/licenses/MIT)
|
|
6
|
+
[](https://www.npmjs.com/package/@raindrop-ai/query)
|
|
12
7
|
|
|
13
8
|
<!-- Start Summary [summary] -->
|
|
14
9
|
## Summary
|
|
@@ -40,34 +35,8 @@ Raindrop Query API (Beta): API for querying Signals, Events, Users, and Conversa
|
|
|
40
35
|
<!-- Start SDK Installation [installation] -->
|
|
41
36
|
## SDK Installation
|
|
42
37
|
|
|
43
|
-
> [!TIP]
|
|
44
|
-
> To finish publishing your SDK to npm and others you must [run your first generation action](https://www.speakeasy.com/docs/github-setup#step-by-step-guide).
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
The SDK can be installed with either [npm](https://www.npmjs.com/), [pnpm](https://pnpm.io/), [bun](https://bun.sh/) or [yarn](https://classic.yarnpkg.com/en/) package managers.
|
|
48
|
-
|
|
49
|
-
### NPM
|
|
50
|
-
|
|
51
|
-
```bash
|
|
52
|
-
npm add https://gitpkg.now.sh/raindrop-ai/query-sdk/typescript
|
|
53
|
-
```
|
|
54
|
-
|
|
55
|
-
### PNPM
|
|
56
|
-
|
|
57
38
|
```bash
|
|
58
|
-
|
|
59
|
-
```
|
|
60
|
-
|
|
61
|
-
### Bun
|
|
62
|
-
|
|
63
|
-
```bash
|
|
64
|
-
bun add https://gitpkg.now.sh/raindrop-ai/query-sdk/typescript
|
|
65
|
-
```
|
|
66
|
-
|
|
67
|
-
### Yarn
|
|
68
|
-
|
|
69
|
-
```bash
|
|
70
|
-
yarn add https://gitpkg.now.sh/raindrop-ai/query-sdk/typescript
|
|
39
|
+
npm install @raindrop-ai/query
|
|
71
40
|
```
|
|
72
41
|
|
|
73
42
|
> [!NOTE]
|
|
@@ -451,13 +420,8 @@ const sdk = new RaindropQuery({ debugLogger: console });
|
|
|
451
420
|
|
|
452
421
|
## Maturity
|
|
453
422
|
|
|
454
|
-
This SDK is in beta
|
|
455
|
-
to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally
|
|
456
|
-
looking for the latest version.
|
|
457
|
-
|
|
458
|
-
## Contributions
|
|
423
|
+
This SDK is in beta. We recommend pinning to a specific version.
|
|
459
424
|
|
|
460
|
-
|
|
461
|
-
We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.
|
|
425
|
+
## Support
|
|
462
426
|
|
|
463
|
-
|
|
427
|
+
For questions or issues, contact support@raindrop.ai
|
package/jsr.json
CHANGED