Skip to content

Commit 5c675b6

Browse files
committed
added README.md
1 parent 2be8ba5 commit 5c675b6

File tree

1 file changed

+48
-0
lines changed

1 file changed

+48
-0
lines changed

README.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
2+
# SAIC Java API
3+
4+
Implementation of the SAIC API in Java.
5+
6+
7+
## Badges
8+
9+
[![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](https://choosealicense.com/licenses/mit/)
10+
11+
![Maven Central](https://img.shields.io/maven-central/v/io.github.saic-ismart-api/saic-ismart-api-parent)
12+
13+
![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/SAIC-iSmart-API/saic-java-client/maven.yml)
14+
15+
## Usage
16+
17+
[MQTT Gateway](saic-java-mqtt-gateway)
18+
19+
20+
## Build locally
21+
22+
Clone the project
23+
24+
```bash
25+
git clone [email protected]:SAIC-iSmart-API/saic-java-client.git
26+
```
27+
28+
Go to the project directory
29+
30+
```bash
31+
cd saic-java-client
32+
```
33+
34+
Build and test
35+
36+
```bash
37+
./mvnw clean verify
38+
```
39+
40+
Skip docker image creation
41+
42+
```bash
43+
./mvnw clean verify -Djib.skip
44+
```
45+
## Contributing
46+
47+
Contributions are always welcome!
48+

0 commit comments

Comments
 (0)