Skip to content

Commit 5604a0f

Browse files
committed
updated readme
1 parent a053d1c commit 5604a0f

File tree

1 file changed

+20
-2
lines changed

1 file changed

+20
-2
lines changed

README.md

+20-2
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,31 @@
11
# DataGenerator [![ Build](https://github.com/Akatsuki06/DataGenerator/actions/workflows/workflow-main.yaml/badge.svg)](https://github.com/Akatsuki06/DataGenerator/actions/workflows/workflow-main.yaml)
2-
This tool can be used to generate data from a yaml schema. This is particularly useful for testing where high volume of mockup data is required.
2+
This tool can be used to generate data from a yaml schema. This is particularly useful in applications where high volume of mockup data is required.
33

44

55
## Usage
66

7+
It can be used as a maven dependency or an executable jar
8+
- To use it as a maven dependency
9+
710
```xml
811
<dependency>
912
<groupId>com.github.akatsuki06</groupId>
1013
<artifactId>data-generator</artifactId>
11-
<version>{version}</version>
14+
<version>0.0.1</version>
1215
</dependency>
1316
```
17+
- To use it as an executable jar download the latest jar `data-generator-0.0.1-exec.jar`
18+
19+
`java -jar data-generator-0.0.1-exec.jar --datagen.schema.path=/path-to-schema/ --datagen.out.path=/output-path/`
20+
21+
22+
## Schema
23+
- Checkout sample schema in `test/resources`
24+
25+
26+
--TBD--
27+
28+
29+
## Documentation
30+
31+
--TBD--

0 commit comments

Comments
 (0)