Skip to content

docs: use activitysmith variable in README #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bardonadam merged 1 commit into from
Feb 7, 2026
Merged

docs: use activitysmith variable in README #10

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,17 +19,17 @@ ESM:
```ts
import ActivitySmith from "activitysmith";

const client = new ActivitySmith({
const activitysmith = new ActivitySmith({
apiKey: process.env.ACTIVITYSMITH_API_KEY,
});

// Push Notifications
await client.notifications.send({
await activitysmith.notifications.send({
// See PushNotificationRequest for fields
});

// Live Activities
await client.liveActivities.start({
await activitysmith.liveActivities.start({
// See LiveActivityStartRequest for fields
});
```
Expand All @@ -39,7 +39,7 @@ CommonJS:
```js
const ActivitySmith = require("activitysmith");

const client = new ActivitySmith({
const activitysmith = new ActivitySmith({
apiKey: process.env.ACTIVITYSMITH_API_KEY,
});
```
Expand All @@ -48,8 +48,8 @@ const client = new ActivitySmith({

The client exposes grouped resources:

- `client.liveActivities`
- `client.notifications`
- `activitysmith.liveActivities`
- `activitysmith.notifications`

Each method is fully typed. Request and response types are included in the type definitions.

Expand Down