Skip to content

Commit 99fb5e8

Browse files
authored
Update README (#966)
1 parent 18a6cfe commit 99fb5e8

File tree

1 file changed

+46
-22
lines changed

1 file changed

+46
-22
lines changed

README.md

Lines changed: 46 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,25 @@
1-
# Stripe Java Bindings [![Build Status](https://travis-ci.org/stripe/stripe-java.svg?branch=master)](https://travis-ci.org/stripe/stripe-java)
1+
# Stripe Java client library
22

3-
You can sign up for a Stripe account at https://stripe.com.
3+
[![Maven Central](https://img.shields.io/maven-central/v/com.stripe/stripe-java)](https://mvnrepository.com/artifact/com.stripe/stripe-java)
4+
[![JavaDoc](http://img.shields.io/badge/javadoc-reference-blue.svg)](https://stripe.dev/stripe-java)
5+
[![Build Status](https://travis-ci.org/stripe/stripe-java.svg?branch=master)](https://travis-ci.org/stripe/stripe-java)
46

5-
## Requirements
6-
7-
Java 1.8 or later.
7+
The official [Stripe][stripe] Java client library.
88

99
## Installation
1010

11+
### Requirements
12+
13+
- Java 1.8 or later
14+
15+
### Gradle users
16+
17+
Add this dependency to your project's build file:
18+
19+
```groovy
20+
implementation "com.stripe:stripe-java:17.9.1"
21+
```
22+
1123
### Maven users
1224

1325
Add this dependency to your project's POM:
@@ -20,32 +32,29 @@ Add this dependency to your project's POM:
2032
</dependency>
2133
```
2234

23-
### Gradle users
24-
25-
Add this dependency to your project's build file:
26-
27-
```groovy
28-
implementation "com.stripe:stripe-java:17.9.1"
29-
```
30-
3135
### Others
3236

3337
You'll need to manually install the following JARs:
3438

35-
* The Stripe JAR from https://github.com/stripe/stripe-java/releases/latest
36-
* [Google Gson](https://github.com/google/gson) from <https://repo1.maven.org/maven2/com/google/code/gson/gson/2.8.5/gson-2.8.5.jar>.
39+
- The Stripe JAR from <https://github.com/stripe/stripe-java/releases/latest>
40+
- [Google Gson][gson] from <https://repo1.maven.org/maven2/com/google/code/gson/gson/2.8.5/gson-2.8.5.jar>.
3741

38-
### [ProGuard](https://www.guardsquare.com/en/products/proguard)
42+
### [ProGuard][proguard]
3943

40-
If you're planning on using ProGuard, make sure that you exclude the Stripe bindings. You can do this by adding the following to your `proguard.cfg` file:
44+
If you're planning on using ProGuard, make sure that you exclude the Stripe
45+
client library. You can do this by adding the following to your `proguard.cfg`
46+
file:
4147

4248
```
4349
-keep class com.stripe.** { *; }
4450
```
4551

4652
## Documentation
4753

48-
Please see the [Java API docs](https://stripe.com/docs/api/java) for the most up-to-date documentation.
54+
Please see the [Java API docs][api-docs] for the most
55+
up-to-date documentation.
56+
57+
You can also refer to the [online Javadoc][javadoc].
4958

5059
## Usage
5160

@@ -80,7 +89,7 @@ public class StripeExample {
8089
}
8190
```
8291

83-
See the project's [functional tests](https://github.com/stripe/stripe-java/blob/master/src/test/java/com/stripe/functional/) for more examples.
92+
See the project's [functional tests][functional-tests] for more examples.
8493

8594
### Per-request Configuration
8695

@@ -180,13 +189,20 @@ go get -u github.com/stripe/stripe-mock
180189
stripe-mock
181190
```
182191

183-
You must have Gradle installed. To run the tests:
192+
To run all checks (tests and code formatting):
193+
194+
```sh
195+
./gradlew check
196+
```
197+
198+
To run the tests:
184199

185200
```sh
186201
./gradlew test
187202
```
188203

189-
You can run particular tests by passing `--tests Class#method`. Make sure you use the fully qualified class name. For example:
204+
You can run particular tests by passing `--tests Class#method`. Make sure you
205+
use the fully qualified class name. For example:
190206

191207
```sh
192208
./gradlew test --tests com.stripe.model.AccountTest
@@ -203,14 +219,22 @@ with:
203219
./gradlew spotlessApply
204220
```
205221

206-
The library uses [Project Lombok][lombok]. While it is not a requirement, you might want to install a [plugin][lombok-plugins] for your favorite IDE to facilitate development.
222+
The library uses [Project Lombok][lombok]. While it is not a requirement, you
223+
might want to install a [plugin][lombok-plugins] for your favorite IDE to
224+
facilitate development.
207225

226+
[api-docs]: https://stripe.com/docs/api/go
208227
[connect-auth]: https://stripe.com/docs/connect/authentication#stripe-account-header
228+
[functional-tests]: https://github.com/stripe/stripe-java/blob/master/src/test/java/com/stripe/functional/
209229
[google-java-format]: https://github.com/google/google-java-format
230+
[gson]: https://github.com/google/gson
210231
[idempotency-keys]: https://stripe.com/docs/api/idempotent_requests?lang=java
232+
[javadoc]: https://stripe.dev/stripe-java
211233
[lombok]: https://projectlombok.org
212234
[lombok-plugins]: https://projectlombok.org/setup/overview
235+
[proguard]: https://www.guardsquare.com/en/products/proguard
213236
[spotless]: https://github.com/diffplug/spotless
237+
[stripe]: https://stripe.com
214238
[stripe-mock]: https://github.com/stripe/stripe-mock
215239

216240
<!--

0 commit comments

Comments
 (0)