Skip to content

Commit 569545c

Browse files
committed
refactor: enhance README for clarity and detail on SDK features
1 parent b28d7b3 commit 569545c

File tree

1 file changed

+4
-9
lines changed

1 file changed

+4
-9
lines changed

README.md

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,13 @@
22

33
[![NPM version](<https://img.shields.io/npm/v/@imagekit/nodejs.svg?label=npm%20(stable)>)](https://npmjs.org/package/@imagekit/nodejs) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/@imagekit/nodejs)
44

5-
This SDK provides everything you need to integrate ImageKit into your server-side applications. Beyond convenient access to the ImageKit REST API, the library includes:
5+
The ImageKit Node.js SDK is a comprehensive library designed to simplify the integration of ImageKit into your server-side applications. It provides powerful tools for working with the ImageKit REST API, including building and transforming URLs, generating signed URLs for secure content delivery, verifying webhooks, and handling file uploads. With robust TypeScript support, this SDK ensures excellent type safety and a seamless developer experience.
66

7-
- **URL Builder & Transformations** - Helper functions to generate optimized image and video URLs with real-time transformations.
8-
- **URL Signing** - Built-in support for generating signed URLs for secure content delivery.
9-
- **Authentication Helpers** - Generate authentication parameters for secure client-side file uploads.
10-
- **Webhook Verification** - Utilities to verify webhook signatures for secure event handling.
7+
The full API of this library is documented in [api.md](api.md). All request parameters and response types are fully typed and importable, offering unparalleled TypeScript support. This ensures that you can rely on accurate type definitions and enjoy a smooth development workflow with modern editors.
118

12-
The REST API documentation can be found on [imagekit.io](https://imagekit.io/docs/api-reference). The full API of this library can be found in [api.md](api.md).
9+
For additional details, refer to the [ImageKit REST API documentation](https://imagekit.io/docs/api-reference).
1310

14-
Refer to the ImageKit official [quick start guide](https://imagekit.io/docs/integration/nodejs) for more details on using the SDK.
15-
16-
If you are looking to integrate file uploads on the client-side, use one of the [client-side SDKs](https://imagekit.io/docs/quick-start-guides#front-end) for easy integration.
11+
If you are looking to integrate file uploads in browsers, use one of our [frontend SDKs](https://imagekit.io/docs/quick-start-guides#front-end).
1712

1813
## Installation
1914

0 commit comments

Comments
 (0)