Skip to content

Commit 9913b84

Browse files
committed
Update README.md
1 parent 24d6610 commit 9913b84

File tree

1 file changed

+6
-19
lines changed

1 file changed

+6
-19
lines changed

README.md

Lines changed: 6 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,21 @@
1-
blockscore-java
2-
===============
1+
## blockscore-java [![Circle CI](https://circleci.com/gh/BlockScore/blockscore-java/tree/java-4.0.svg?style=shield)](https://circleci.com/gh/BlockScore/blockscore-java/tree/java-4.0)
32

43
An API wrapper for the BlockScore API using Java.
54

6-
Latest Revision: <b>4.0.0</b> <br />
7-
API Compatibility: <b>4.0</b>
8-
9-
##Release Notes
10-
Version: 4.0.0
11-
12-
1. API Version 4.0 now supported.
13-
14-
##System Requirements (For building and usage)
5+
### System Requirements
156
1. Java 1.7+
167

17-
##How to build
8+
## How to build
189
1. Clone this repository
1910
2. `./gradlew build`
2011
3. `./gradlew jar` (Builds the standard JAR) or `./gradlew fatJar` (Builds the plug and play jar)
2112

22-
##How to run code quality tools
23-
1. Checkstyle (Ensures code style) `./gradlew checkstyleMain`
24-
2. PMD (Checks for bugs) `./gradlew pmdMain`
25-
3. Findbugs (Checks for bugs) `./gradlew findbugsMain`
26-
4. JUnit (Tests) `./gradlew build`
13+
## Usage
2714

28-
##How to generate javadocs
15+
## Generating javadocs
2916
1. `./gradlew docs`
3017

31-
##Dependencies Required (If using standard JAR)
18+
## Dependencies
3219
1. Retrofit 1.6.1+
3320
2. Retrofit Converter-Jackson 1.6.1+
3421
3. OkHTTP 2.0+

0 commit comments

Comments
 (0)