Skip to content

Commit

Permalink
Update README instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
nyg committed Jan 27, 2024
1 parent 65114c3 commit 34050d6
Showing 1 changed file with 20 additions and 4 deletions.
24 changes: 20 additions & 4 deletions README.md
@@ -1,8 +1,24 @@
# A Kraken API Client in Java

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

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

https://www.kraken.com/en-us/help/api
### Examples

Run the examples with:

```shell
# input your API keys in api-keys.properties
cp examples/src/main/resources/api-keys.properties.example \
examples/src/main/resources/api-keys.properties

# build project
mvn clean install

# run Examples class
mvn -q -pl examples exec:java -Dexec.mainClass=dev.andstuff.kraken.example.Examples
```


[1]: https://www.kraken.com/en-us/help/api

0 comments on commit 34050d6

Please sign in to comment.