-
Notifications
You must be signed in to change notification settings - Fork 2
Update README.md #6
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
Changed all references from Nexmo->Vonage
| @@ -1,2 +1,134 @@ | |||
| # vonage-spring-boot-starter-java | |||
| Spring Boot Starter for Vonage | |||
| # vonage Spring Boot Starter | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The "v" in vonage should be capitalized. Also add the world "Java" to the ends so that it matches the name of the project.
|
|
||
| <img src="https://developer.nexmo.com/assets/images/Vonage_Nexmo.svg" height="48px" alt="Nexmo is now known as Vonage" /> | ||
|
|
||
| This Spring Boot Starter has been provided to help with integrating the [Nexmo Java SDK](https://github.com/Nexmo/Nexmo-java) into your [Spring Boot](https://spring.io/projects/spring-boot) project. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Link title should change from "Nexmo Java SDK" to "Vonage Java Server SDK"
| * [Installation](#installation) | ||
| * [Usage](#usage) | ||
| * [Customizing the VonageClient](#customizing-the-vonageclient) | ||
| * [Customize vonage Client Version](#customize-vonage-client-version) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The "v" in vonage should be capitalized.
| } | ||
| dependencies { | ||
| implementation 'com.vonage:vonage-spring-boot-starter:1.1.0' |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Change com.vonage:vonage-spring-boot-starter:1.1.0 to com.vonage:vonage-spring-boot-starter:1.0.0
| <dependency> | ||
| <groupId>com.vonage</groupId> | ||
| <artifactId>vonage-spring-boot-starter</artifactId> | ||
| <version>1.1.0</version> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
version should be 1.0.0
| ## Customize vonage Client Version | ||
|
|
||
| By default, the Vonage Spring Boot Starter will transitively define Vonage Client to the latest version at its release. You can override this by adding a dependency on the Vonage Client, bringing in `4.2.0` for example: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Current version of the dependency is 5.5.0
| } | ||
| dependencies { | ||
| implementation 'com.vonage:client:4.2.0' |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Current version of the dependency is 5.5.0
| <dependency> | ||
| <groupId>com.vonage</groupId> | ||
| <artifactId>client</artifactId> | ||
| <version>4.2.0</version> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Current version of the dependency is 5.5.0
|
|
||
| | Vonage Spring Boot Starter | Vonage Java Client | | ||
| |---|---| | ||
| | v1.0.0 | v4.3.0 | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There should only be 1 row entry in the table here. and that should be | v1.0.0 | v5.5.0 | since
|
|
||
| Bringing in older versions of the supported Vonage Client, may result in some unforseen consequences and build errors. As a result here is a list of each version targeted by each version of the starter: | ||
|
|
||
| | Vonage Spring Boot Starter | Vonage Java Client | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Change "Vonage Spring Boot Starter" to "Vonage Spring Boot Starter Java"
Changed all references from Nexmo->Vonage. However references to shield links haven't changed. Please let me know about errors.
Closes #2