Skip to content

Commit 4e3f059

Browse files
committed
fixed doc structure
1 parent 1a609f4 commit 4e3f059

File tree

1 file changed

+22
-20
lines changed

1 file changed

+22
-20
lines changed

README.adoc

Lines changed: 22 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,31 @@ Redis Input/Output Tool (RIOT) is a data import/export tool for Redis and Redis
55

66
== Input Sources
77

8-
RIOT supports multiple input sources.
8+
* Databases (JDBC)
9+
* Files
10+
** Delimited (CSV)
11+
** Fixed-width
12+
** JSON
13+
* Generator
14+
** Simple (sequence)
15+
** https://github.com/stympy/faker[Faker] data
916

10-
=== Databases
11-
Databases are supported through JDBC. Add the appropriate driver jar for your database under the `lib` directory, e.g. for MySQL: `lib/mysql-connector-java-5.1.47.jar`
17+
== Installation
18+
Download the https://github.com/Redislabs-Solution-Architects/riot/releases/latest[latest RIOT distribution] (zip or tar.gz) and unpack the downloaded archive.
19+
20+
== Running
21+
Use the `riot` script (`riot.bat` for Windows) to launch RIOT.
1222

13-
=== Files
14-
RIOT supports the following file formats:
23+
== Usage
24+
Follow the usage help provided with the `--help` option.
25+
26+
=== Databases
1527

16-
==== Delimited (CSV)
28+
WARNING: Add the appropriate driver jar for your database under the `lib` directory
1729

18-
==== Fixed-width
30+
For example with MySQL: `lib/mysql-connector-java-5.1.47.jar`
1931

20-
==== JSON
32+
=== JSON
2133
RIOT can read JSON data from a file with the following format:
2234
[source,json]
2335
----
@@ -32,23 +44,13 @@ RIOT can read JSON data from a file with the following format:
3244
----
3345

3446
=== Generator
35-
RIOT can also import generated data.
3647

37-
==== Simple Generator
48+
==== Simple
3849
The simple data generator generates entries with a single field named `field` which is a sequence of integers.
3950

40-
==== Faker Generator
51+
==== Faker
4152
This data generator relies on the https://github.com/DiUS/java-faker[Faker] library.
4253

43-
== Installation
44-
Download the https://github.com/Redislabs-Solution-Architects/riot/releases/latest[latest RIOT distribution] (zip or tar.gz) and unpack the downloaded archive.
45-
46-
== Running
47-
Use the `riot` script (`riot.bat` for Windows) to launch RIOT.
48-
49-
== Usage
50-
Follow the usage help provided with the `--help` option.
51-
5254
== Examples
5355

5456
=== Importing from databases

0 commit comments

Comments
 (0)