Skip to content

Commit

Permalink
fix readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Watson Zuo committed Oct 14, 2024
1 parent 8f9f7ae commit b10b4c8
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ If you need support using AfterShip products, please contact [email protected]
- [AfterShip Tracking API library for Node.js](#aftership-tracking-api-library-for-nodejs)
- [Table of Contents](#table-of-contents)
- [Before you begin](#before-you-begin)
- [API and SDK Version](#api-and-sdk-version)
- [Quick Start](#quick-start)
- [Installation](#installation)
- [Usage](#usage)
Expand All @@ -36,6 +37,16 @@ Before you begin to integrate:
- [Create an API key](https://organization.automizely.com/api-keys).
- [Install Node.js](https://nodejs.org/en/download/) version 16 or later.

### API and SDK Version

Each SDK version is designed to work with a specific API version. Please refer to the table below to identify the supported API versions for each SDK version, ensuring you select the appropriate SDK version for the API version you intend to use.

| SDK Version | Supported API Version | Branch |
| --- | --- | --- |
| 9.x.x | 2024-04 | https://github.com/AfterShip/tracking-sdk-nodejs/tree/2024-04 |
| 8.x.x | 2023-10 | https://github.com/AfterShip/aftership-sdk-nodejs |
| <=7.x.x | Legacy API | https://github.com/AfterShip/aftership-sdk-nodejs |

## Quick Start

### Installation
Expand Down Expand Up @@ -321,4 +332,4 @@ If you get stuck, we're here to help:
## License
Copyright (c) 2024 AfterShip

Licensed under the MIT license.
Licensed under the MIT license.

0 comments on commit b10b4c8

Please sign in to comment.