Skip to content

Commit 7cb7cd9

Browse files
committed
docs: Adjust Java README and migration guide for v10 (box/box-codegen#782)
1 parent 3bf4cc5 commit 7cb7cd9

File tree

3 files changed

+188
-100
lines changed

3 files changed

+188
-100
lines changed

.codegen.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{ "engineHash": "f39bd50", "specHash": "bad862d", "version": "0.1.0" }
1+
{ "engineHash": "be39be6", "specHash": "bad862d", "version": "0.1.0" }

README.md

Lines changed: 15 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
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 Gen
5+
# Box Java SDK
66

77
[![Project Status](http://opensource.box.com/badges/active.svg)](http://opensource.box.com/badges)
8-
![build](https://github.com/box/box-java-sdk-gen/actions/workflows/build.yml/badge.svg)
9-
![Maven Central Version](https://img.shields.io/maven-central/v/com.box/box-java-sdk-gen)
8+
![build](https://github.com/box/box-java-sdk/actions/workflows/build.yml/badge.svg)
9+
![Maven Central Version](https://img.shields.io/maven-central/v/com.box/box-java-sdk)
1010
![Platform](https://img.shields.io/badge/java-%3E%3D8-blue)
11-
[![Coverage](https://coveralls.io/repos/github/box/box-java-sdk-gen/badge.svg?branch=main)](https://coveralls.io/github/box/box-java-sdk-gen?branch=main)
11+
[![Coverage](https://coveralls.io/repos/github/box/box-java-sdk/badge.svg?branch=sdk-gen)](https://coveralls.io/github/box/box-java-sdk-gen?branch=sdk-gen)
1212

13-
We are excited to introduce the Beta Release of the latest generation of Box Java SDK Gen, designed to elevate the developer experience and streamline your integration with the Box Content Cloud.
13+
We are excited to introduce the stable Release of the latest generation of Box Java SDK, designed to elevate the developer experience and streamline your integration with the Box Content Cloud.
1414

1515
With this SDK, you’ll have access to:
1616

@@ -27,7 +27,7 @@ Embrace the new generation of Box SDKs and unlock the full potential of the Box
2727
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
2828
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
2929

30-
- [Box Java SDK Gen](#box-java-sdk-gen)
30+
- [Box Java SDK](#box-java-sdk)
3131
- [Table of contents](#table-of-contents)
3232
- [Installing](#installing)
3333
- [Getting Started](#getting-started)
@@ -46,31 +46,24 @@ Embrace the new generation of Box SDKs and unlock the full potential of the Box
4646

4747
# Installing
4848

49-
To generate a .jar file download the source code and run the following command:
50-
51-
```console
52-
./gradlew build
53-
```
54-
55-
.jar file will be generated in the build/libs directory.
56-
57-
The SDK is also available on [Maven Central Repository](https://mvnrepository.com/artifact/com.box/box-java-sdk-gen). To include the SDK in your project, add the following dependency to your `pom.xml` file:
49+
The SDK is available on [Maven Central Repository](https://mvnrepository.com/artifact/com.box/box-java-sdk). To include the SDK in your project, add the following dependency to your `pom.xml` file:
5850

5951
```xml
6052
<dependency>
6153
<groupId>com.box</groupId>
62-
<artifactId>box-java-sdk-gen</artifactId>
54+
<artifactId>box-java-sdk</artifactId>
6355
<version>VERSION</version>
6456
</dependency>
6557
```
6658

6759
To include the SDK in your project using Gradle, add the following dependency to your `build.gradle` file:
6860

6961
```gradle
70-
implementation 'com.box:box-java-sdk-gen:VERSION'
62+
implementation 'com.box:box-java-sdk:VERSION'
7163
```
7264

73-
Where `VERSION` is the version of the SDK you want to use. You can find the latest version in the [Maven Central Repository](https://mvnrepository.com/artifact/com.box/box-java-sdk-gen).
65+
Where `VERSION` is the version of the SDK you want to use. The next generation of the SDK starts with version `10.0.0`.
66+
You can find the latest version in the [Maven Central Repository](https://mvnrepository.com/artifact/com.box/box-java-sdk).
7467

7568
# Getting Started
7669

@@ -97,7 +90,7 @@ Browse the [docs](docs/README.md) or see [API Reference](https://developer.box.c
9790

9891
# Upgrades
9992

100-
The SDK is updated regularly to include new features, enhancements, and bug fixes. If you are upgrading from our legacy SDKs to this new generation SDKs is a straightforward process. Checkout the [migration guide](MIGRATION_GUIDE.md) and [changelog](CHANGELOG.md) for more information.
93+
The SDK is updated regularly to include new features, enhancements, and bug fixes. If you are upgrading from manual SDK to this new generated SDKm checkout the [migration guide](MIGRATION_GUIDE.md) and [changelog](CHANGELOG.md) for more information.
10194

10295
# Integration Tests
10396

@@ -136,7 +129,7 @@ To run integration tests locally, you can use the following command:
136129

137130
# 3rd Party Libraries & Licenses
138131

139-
The Java SDK Gen uses third-party libraries that are required for usage. Their licenses are listed below:
132+
The Java SDK uses third-party libraries that are required for usage. Their licenses are listed below:
140133

141134
1. [jackson-annotations v2.17.2](https://mvnrepository.com/artifact/com.fasterxml.jackson.core/jackson-annotations/2.17.2)
142135
Maven: `com.fasterxml.jackson.core:jackson-annotations:2.17.2`
@@ -175,9 +168,9 @@ The following libraries are required for running tests:
175168
# Questions, Bugs, and Feature Requests?
176169

177170
Need to contact us directly? [Browse the issues
178-
tickets](https://github.com/box/box-java-sdk-gen/issues)! Or, if that
171+
tickets](https://github.com/box/box-java-sdk/issues)! Or, if that
179172
doesn't work, [file a new
180-
one](https://github.com/box/box-java-sdk-gen/issues/new) and we will get
173+
one](https://github.com/box/box-java-sdk/issues/new) and we will get
181174
back to you. If you have general questions about the Box API, you can
182175
post to the [Box Developer Forum](https://forum.box.com/).
183176

0 commit comments

Comments
 (0)