Skip to content

Commit 9b6f2c3

Browse files
committed
docs: Improve README.md
1 parent 8076cd2 commit 9b6f2c3

File tree

1 file changed

+23
-10
lines changed

1 file changed

+23
-10
lines changed

README.md

Lines changed: 23 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<img src="https://github.com/box/sdks/blob/master/images/box-dev-logo.png" alt= “box-dev-logo” width="30%" height="50%">
33
</p>
44

5-
# Box Java SDK
5+
# Box Java SDK v5
66

77
[![Project Status](http://opensource.box.com/badges/active.svg)](http://opensource.box.com/badges)
88
![Platform](https://img.shields.io/badge/java-%3E%3D8-blue)
@@ -13,6 +13,7 @@
1313
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
1414
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
1515

16+
- [Introduction](#introduction)
1617
- [Supported versions](#supported-versions)
1718
- [Version v5](#version-v5)
1819
- [Version v10](#version-v10)
@@ -28,7 +29,6 @@
2829
- [Migration guides](#migration-guides)
2930
- [Versioning](#versioning)
3031
- [Version schedule](#version-schedule)
31-
- [Version schedule](#version-schedule-1)
3232
- [Contributing](#contributing)
3333
- [3rd Party Libraries & Licenses](#3rd-party-libraries--licenses)
3434
- [Android](#android)
@@ -38,9 +38,24 @@
3838

3939
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
4040

41+
# Introduction
42+
43+
We are excited to introduce the v10 major release of the Box Java SDK,
44+
designed to elevate the developer experience and streamline your integration with the Box Content Cloud.
45+
46+
With this SDK, we provide the `com.box.sdkgen` package, which gives you access to:
47+
48+
1. Full API Support: The new generation of Box SDKs empowers developers with complete coverage of the Box API ecosystem. You can now access all the latest features and functionalities offered by Box, allowing you to build even more sophisticated and feature-rich applications.
49+
2. Rapid API Updates: Say goodbye to waiting for new Box APIs to be incorporated into the SDK. With our new auto-generation development approach, we can now add new Box APIs to the SDK at a much faster pace (in a matter of days). This means you can leverage the most up-to-date features in your applications without delay.
50+
3. Embedded Documentation: We understand that easy access to information is crucial for developers. With our new approach, we have included comprehensive documentation for all objects and parameters directly in the source code of the SDK. This means you no longer need to look up this information on the developer portal, saving you time and streamlining your development process.
51+
4. Enhanced Convenience Methods: Our commitment to enhancing your development experience continues with the introduction of convenience methods. These methods cover various aspects such as chunk uploads, classification, and much more.
52+
5. Seamless Start: The new SDKs integrate essential functionalities like authentication, automatic retries with exponential backoff, exception handling, request cancellation, and type checking, enabling you to focus solely on your application's business logic.
53+
54+
Embrace the new generation of Box SDKs and unlock the full potential of the Box Content Cloud.
55+
4156
# Supported versions
4257

43-
To enhance developer experience, provide full Box API coverage, and rapid updates we have introduced the new generated codebase through the `com.box.sdkgen` package.
58+
To enhance developer experience, we have introduced the new generated codebase through the `com.box.sdkgen` package.
4459
The `com.box.sdkgen` package is available in two major supported versions: v5 and v10.
4560

4661
## Version v5
@@ -218,8 +233,6 @@ We highly recommend upgrading to the latest SDK major release at the earliest co
218233

219234
## Version schedule
220235

221-
### Version schedule
222-
223236
| Version | Supported Environments | State | First Release | EOL/Terminated |
224237
|---------|------------------------|-----------|---------------|------------------------|
225238
| 10 | Java 8 and up | Supported | 17 Sep 2025 | TBD |
@@ -330,8 +343,8 @@ Furthermore,using Bouncy Castle v.1.57 may lead to [Bouncycastle BadPaddingExcep
330343
Gradle example
331344
```groovy
332345
implementation('com.box:box-java-sdk:x.y.z') {
333-
exclude group: 'org.bouncycastle', module: 'bcprov-jdk15on'
334-
exclude group: 'org.bouncycastle', module: 'bcpkix-jdk15on'
346+
exclude group: 'org.bouncycastle', module: 'bcprov-jdk18on'
347+
exclude group: 'org.bouncycastle', module: 'bcpkix-jdk18on'
335348
}
336349
runtimeOnly('org.bouncycastle:bcprov-jdk15on:1.57')
337350
runtimeOnly('org.bouncycastle:bcpkix-jdk15on:1.57')
@@ -348,11 +361,11 @@ Maven example:
348361
<exclusions>
349362
<exclusion>
350363
<groupId>org.bouncycastle</groupId>
351-
<artifactId>bcprov-jdk15on</artifactId>
364+
<artifactId>bcprov-jdk18on</artifactId>
352365
</exclusion>
353366
<exclusion>
354367
<groupId>org.bouncycastle</groupId>
355-
<artifactId>bcpkix-jdk15on</artifactId>
368+
<artifactId>bcpkix-jdk18on</artifactId>
356369
</exclusion>
357370
</exclusions>
358371
</dependency>
@@ -379,7 +392,7 @@ back to you. If you have general questions about the Box API, you can post to th
379392

380393
## Copyright and License
381394

382-
Copyright 2019 Box, Inc. All rights reserved.
395+
Copyright 2025 Box, Inc. All rights reserved.
383396

384397
Licensed under the Apache License, Version 2.0 (the "License");
385398
you may not use this file except in compliance with the License.

0 commit comments

Comments
 (0)