Skip to content
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.

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

Update README.md #169

Closed
wants to merge 2 commits into from
Closed
Changes from all commits
Commits
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
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,12 @@ You will need to get a Courier API key to get started. You can sign up and creat
v6 of our SDK is automatically generated by [Fern](https://buildwithfern.com/). v6 comes
with several improvements that we describe below:

- **Instantiate the client**: `CourierClient` is now a class and must be instantiated.
```ts
import { CourierClient } from "@trycourier/courier";

const courier = new CourierClient();
```
- **Resource-scoped SDK methods**: Endpoints are scoped under their resource. For
example, instead of `courier.deleteBrands` the SDK now reads `courier.brands.delete(...)`
- **Docs on Hover**: All endpoint and parameter level documentation that you see
Expand Down