Skip to content

Commit 7be5f14

Browse files
committed
Improve description
1 parent 655dfe7 commit 7be5f14

1 file changed

Lines changed: 11 additions & 1 deletion

File tree

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,17 @@
22

33
[![codecov](https://codecov.io/gh/AzulImplementation/AzulApiJava/branch/main/graph/badge.svg)](https://codecov.io/gh/AzulImplementation/AzulApiJava)
44

5-
# Building and running the API
5+
## Using the API
6+
7+
Download the jar file from [https://github.com/AzulImplementation/AzulApiJava/releases](releases).
8+
9+
Execute: `java -jar target/azulapi.jar <number of players (from 2 to 4)>`.
10+
11+
# Running the API with Maven
12+
13+
If you have Maven installed you can use: `mvn spring-boot:run "-Dspring-boot.run.arguments=<number of players (from 2 to 4)>"`
14+
15+
or:
616

717
```
818
mvn clean package

0 commit comments

Comments
 (0)