Skip to content

Commit 34050d6

Browse files
committed
Update README instructions
1 parent 65114c3 commit 34050d6

File tree

1 file changed

+20
-4
lines changed

1 file changed

+20
-4
lines changed

README.md

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,24 @@
11
# A Kraken API Client in Java
22

3-
Query the Kraken API in Java.
3+
![Maven Central](https://img.shields.io/maven-central/v/dev.andstuff.kraken/kraken-api)
44

5-
Execute `mvn clean package` and the JAR will be in the `target` folder. After that, `Examples.java` can also be executed
6-
using `java -cp target/classes edu/self/kraken/Examples`.
5+
Query the [Kraken API][1] in Java.
76

8-
https://www.kraken.com/en-us/help/api
7+
### Examples
8+
9+
Run the examples with:
10+
11+
```shell
12+
# input your API keys in api-keys.properties
13+
cp examples/src/main/resources/api-keys.properties.example \
14+
examples/src/main/resources/api-keys.properties
15+
16+
# build project
17+
mvn clean install
18+
19+
# run Examples class
20+
mvn -q -pl examples exec:java -Dexec.mainClass=dev.andstuff.kraken.example.Examples
21+
```
22+
23+
24+
[1]: https://www.kraken.com/en-us/help/api

0 commit comments

Comments
 (0)