Skip to content

Commit 504d021

Browse files
committed
cp dines
1 parent 63c65c7 commit 504d021

1 file changed

Lines changed: 7 additions & 26 deletions

File tree

README.md

Lines changed: 7 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -51,18 +51,9 @@ await devbox.shutdown();
5151

5252
## Core Concepts
5353

54-
### [RunloopSDK](https://runloopai.github.io/api-client-ts/stable/classes/RunloopSDK.html)
54+
### Runloop ADK
5555

56-
The main SDK class that provides access to all Runloop functionality:
57-
58-
```typescript
59-
import { RunloopSDK } from '@runloop/api-client';
60-
61-
const sdk = new RunloopSDK({
62-
bearerToken: 'your-api-key',
63-
// ... other options
64-
});
65-
```
56+
The main SDK class that provides access to all Runloop functionality construct view the [RunloopSDK documentation](https://runloopai.github.io/api-client-ts/stable/classes/RunloopSDK.html) to see specific capabilities.
6657

6758
### Available Resources
6859

@@ -72,27 +63,17 @@ The SDK provides object-oriented interfaces for all major Runloop resources:
7263
- **[`sdk.blueprint`](https://runloopai.github.io/api-client-ts/stable/classes/RunloopSDK.Blueprint.html)** - Blueprint management (create, list, build blueprints)
7364
- **[`sdk.snapshot`](https://runloopai.github.io/api-client-ts/stable/classes/RunloopSDK.Snapshot.html)** - Snapshot management (list disk snapshots)
7465
- **[`sdk.storageObject`](https://runloopai.github.io/api-client-ts/stable/classes/RunloopSDK.StorageObject.html)** - Storage object management (upload, download, list objects)
75-
- **[`sdk.api`](https://runloopai.github.io/api-client-ts/stable/classes/Runloop.html)** - Direct access to the legacy REST API client
76-
77-
## Installation
78-
79-
```sh
80-
npm install @runloop/api-client
81-
```
82-
83-
## Usage
84-
85-
The full API of this library can be found in [api.md](api.md).
66+
- **[`sdk.api`](https://runloopai.github.io/api-client-ts/stable/classes/Runloop.html)** - Direct access to the REST API client
8667

8768
<!-- prettier-ignore -->
8869
```js
89-
import Runloop from '@runloop/api-client';
70+
import { RunloopSDK } from '@runloop/api-client';
9071

91-
const client = new Runloop({
72+
const client = new RunloopSDK({
9273
bearerToken: process.env['RUNLOOP_API_KEY'], // This is the default and can be omitted
9374
});
9475

95-
const devboxView = await client.devboxes.create();
76+
const devboxView = await client.api.devboxes.create();
9677

9778
console.log(devboxView.id);
9879
```
@@ -189,7 +170,7 @@ only 429 errors will be retried.
189170
You can use the `maxRetries` option to configure or disable this:
190171

191172
<!-- prettier-ignore -->
192-
```js
173+
```ts
193174
// Configure the default for all requests:
194175
const client = new Runloop({
195176
maxRetries: 0, // default is 5

0 commit comments

Comments
 (0)