Skip to content

Commit f53cf54

Browse files
committed
docs(readme): update formatting and usage section
1 parent cdcefa2 commit f53cf54

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,12 @@ The library reads all the metadata it needs from the entity class (index name, i
88

99
## Features
1010

11-
* **Simple API** and no configuration required
12-
* Support for **JUnit 4** via `LoadEsDataRule`
13-
* Support for **JUnit Jupiter** via `@LoadEsDataConfig` or `@LoadEsDataExtension`
14-
* Built-in support for **gzipped data**
15-
* Written in **Java 8**
16-
* Based on **Spring (Data, Test)**
17-
11+
* **Simple API** and no configuration required
12+
* Support for **JUnit 4** via `LoadEsDataRule`
13+
* Support for **JUnit Jupiter** via `@LoadEsDataConfig` or `@LoadEsDataExtension`
14+
* Built-in support for **gzipped data**
15+
* Written in **Java 8**
16+
* Based on **Spring (Data, Test)**
1817

1918
## Dependencies
2019

@@ -25,7 +24,7 @@ The library reads all the metadata it needs from the entity class (index name, i
2524

2625
## Installation & Usage
2726

28-
The library is splitted into 2 independent sub-modules, both will be available on Maven Central (*soon*):
27+
The library is splitted into 2 independent sub-modules, both will be available on [Bintray](https://bintray.com/tinesoft/maven), Maven Central (*soon*):
2928

3029
* `spring-esdata-loader-junit4` for testing with **JUnit 4**
3130
* `spring-esdata-loader-junit-jupiter` for testing with **JUnit Jupiter**
@@ -76,8 +75,8 @@ To get started,
7675

7776
2. write your test class. You can have a look at:
7877

79-
* [junit4](/junit4) - if your are using **JUnit 4**
80-
* [junit-jupiter](/junit-jupiter) - if you are using **JUnit Jupiter**
78+
* [junit4](/junit4) - if your are using **JUnit 4**
79+
* [junit-jupiter](/junit-jupiter) - if you are using **JUnit Jupiter**
8180

8281
## Data Format
8382

@@ -102,6 +101,7 @@ from your Elasticseach server, and them dump them into a JSON file.
102101
```
103102
$ npx elasticdump --input=http://localhost:9200/my_index --output=my_index_data.json
104103
```
104+
105105
> The above command will run `elasticdump` to extract data from an index named `my_index` on a ES server located at http://localhost:9200 and then save the result into a file named `my_index_data.json`
106106
107107
> If you change the `--output` part above into `--output=$ | gzip my_data.json.gz` the data will be automatically gzipped

0 commit comments

Comments
 (0)