@cloudfleet/sdk 0.12.3 → 1.0.1

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 CHANGED
@@ -1,9 +1,33 @@
1
- # Cloudfleet TypeScript API client
1
+ # Cloudfleet SDK for TypeScript & JavaScript
2
2
 
3
- TypeScript client for the Cloudfleet API.
3
+ Official TypeScript/JavaScript SDK for the [Cloudfleet](https://cloudfleet.ai) API.
4
+
5
+ [Cloudfleet](https://cloudfleet.ai) is a managed Kubernetes platform that runs your clusters across any cloud and your own bare-metal servers. This SDK is a fully typed client for automating clusters, fleets, nodes, and billing from Node.js, the browser, or any TypeScript project.
6
+
7
+ - 🌐 Homepage: [cloudfleet.ai](https://cloudfleet.ai)
8
+ - 📚 Docs: [cloudfleet.ai/docs](https://cloudfleet.ai/docs)
4
9
 
5
10
  ## Installation
6
11
 
7
12
  ```bash
8
13
  npm install @cloudfleet/sdk
9
14
  ```
15
+
16
+ ## Usage
17
+
18
+ ```ts
19
+ import { client } from "@cloudfleet/sdk";
20
+
21
+ client.setConfig({
22
+ baseUrl: "https://api.cloudfleet.ai/v1",
23
+ headers: {
24
+ Authorization: "Bearer <your-token>",
25
+ },
26
+ });
27
+ ```
28
+
29
+ The package ships full TypeScript types and an optional [`@tanstack/react-query`](https://tanstack.com/query) integration via `@cloudfleet/sdk/@tanstack/react-query`. See the [Cloudfleet docs](https://cloudfleet.ai/docs) for the full API reference and authentication details.
30
+
31
+ ## License
32
+
33
+ MIT