Skip to content

Commit fe98467

Browse files
committed
update docs
1 parent f5e1ddd commit fe98467

File tree

1 file changed

+18
-8
lines changed

1 file changed

+18
-8
lines changed

README.md

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@
88
[![Project Status](http://opensource.box.com/badges/active.svg)](http://opensource.box.com/badges)
99
[![Known Vulnerabilities](https://snyk.io/test/github/box/box-node-sdk/badge.svg)](https://snyk.io/test/github/box/box-node-sdk)
1010
![Platform](https://img.shields.io/badge/node-18--24-blue)
11-
[![Project Status](http://opensource.box.com/badges/active.svg)](http://opensource.box.com/badges)
1211
[![Coverage](https://coveralls.io/repos/github/box/box-node-sdk/badge.svg?branch=main)](https://coveralls.io/github/box/box-node-sdk?branch=main)
1312

1413
A Node.js interface to the [Box Content API](https://developer.box.com/reference/).
@@ -21,6 +20,8 @@ A Node.js interface to the [Box Content API](https://developer.box.com/reference
2120
- [Version v4](#version-v4)
2221
- [Version v10](#version-v10)
2322
- [Installation](#installation)
23+
- [Installing v10 (Generated SDK only)](#installing-v10-generated-sdk-only)
24+
- [Installing v4 (Both Generated and Manual SDK)](#installing-v4-both-generated-and-manual-sdk)
2425
- [Getting Started](#getting-started)
2526
- [With generated SDK](#with-generated-sdk)
2627
- [With manually written SDK](#with-manually-written-sdk)
@@ -54,7 +55,7 @@ A Node.js interface to the [Box Content API](https://developer.box.com/reference
5455

5556
In v4 of the Box Node SDK, we are introducing a version that consolidates both the manually written SDK (formerly known as v3) and the generated SDK (currently in v10, formerly known as [box-typescript-sdk-gen](https://github.com/box/box-typescript-sdk-gen)) into a single SDK package for improved usability and maintenance. This allows developers to use both the manually written SDK and the generated SDK in the same project.
5657

57-
Version v4 of the Box Node SDK will be supporte until 2027. During this period, the manually written SDK will be marked as deprecated and will receive only bug fixes and security updates.
58+
Version v4 of the Box Node SDK will be supported until 2027. During this period, the manually written SDK will be marked as deprecated and will receive only bug fixes and security updates.
5859
All new features and functionality will be provided exclusively in the `sdk-gen` namespace.
5960

6061
The codebase for v4 of the Box Node SDK is currently available in the [combined-sdk](https://github.com/box/box-node-sdk/tree/combined-sdk) branch.
@@ -79,17 +80,26 @@ You can find the migration guide [here](https://github.com/box/box-node-sdk/blob
7980

8081
# Installation
8182

82-
Node SDK Installation [details](https://developer.box.com/guides/tooling/sdks/node/).
83+
For general Node SDK installation details, see the [Box Developer documentation](https://developer.box.com/guides/tooling/sdks/node/).
8384

84-
The installation process for v4 of the Box Node SDK is similar, but there are some differences in the version number you need to use.
85+
## Installing v10 (Generated SDK only)
8586

86-
In version v4, all classes and methods of manually written SDK are available in the `box-node-sdk` package, and the generated SDK is available in the `box-node-sdk/sdk-gen` namespace.
87+
If you want to use only the generated SDK with the latest features:
8788

88-
To install v4 of the Box Node SDK, you can use the following command:
89+
```bash
90+
npm install --save box-node-sdk@^10
8991
```
92+
93+
## Installing v4 (Both Generated and Manual SDK)
94+
95+
If you need to use both the generated SDK and the manually written SDK (for migration purposes):
96+
97+
```bash
9098
npm install --save box-node-sdk@^4
9199
```
92100

101+
In version v4, the manually written SDK is available in the `box-node-sdk` package, and the generated SDK is available in the `box-node-sdk/sdk-gen` namespace.
102+
93103
# Getting Started
94104

95105
To get started with the SDK, get a Developer Token from the Configuration page
@@ -100,7 +110,7 @@ You can use this token to make test calls for your own Box account.
100110

101111
## With generated SDK
102112

103-
The SDK provides a `DeveloperTokenAuth` class, which allows you to authenticate using your Developer Token. Use instance of `DeveloperTokenAuth` to initialize `Client` object. Using `Client` object you can access managers, which allow you to perform some operations on your Box account.
113+
The SDK provides a `BoxDeveloperTokenAuth` class, which allows you to authenticate using your Developer Token. Use an instance of `BoxDeveloperTokenAuth` to initialize a `BoxClient` object. Using the `BoxClient` object you can access managers, which allow you to perform operations on your Box account.
104114

105115
The example below demonstrates how to authenticate with Developer Token and print names of all items inside a root folder.
106116

@@ -367,7 +377,7 @@ We use a modified version of [Semantic Versioning](https://semver.org/) for all
367377

368378
## Supported Version
369379

370-
Currently, we support the v10 version and v3 version of the SDK. New features, functionality, bug fixes, and security updates will only be added to these versions.
380+
Currently, we support versions v10, v4 of the SDK. New features and functionality are added to v10, while the manually written portion of v4 receive bug fixes and security updates only.
371381

372382
A current release is on the leading edge of our SDK development, and is intended for customers who are in active development and want the latest and greatest features.
373383
Instead of stating a release date for a new feature, we set a fixed minor or patch release cadence of maximum 2-3 months (while we may release more often).

0 commit comments

Comments
 (0)