Skip to content

Commit c6349ef

Browse files
authored
Update README.md
1 parent 7872a65 commit c6349ef

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,22 @@
33
Versioned Key-Value Store with RocksDB backend and gRPC API
44

55
[![CircleCI](https://circleci.com/gh/scalableminds/fossildb.svg?style=svg&circle-token=89b8341a216f2ce9e8f40c913b45196b3694347a)](https://circleci.com/gh/scalableminds/fossildb)
6+
7+
## Installation & Usage
8+
You can download the [executable jar](https://github.com/scalableminds/fossildb/releases/latest),
9+
```
10+
java -jar fossildb.jar -c default
11+
```
12+
or use a [docker image](https://hub.docker.com/r/scalableminds/fossildb/tags) and run
13+
```
14+
docker run scalableminds/fossildb:master fossildb -c default
15+
```
16+
17+
For further options, see `help`:
18+
```
19+
-p, --port <num> port to listen on. Default: 7155
20+
-d, --dataDir <path> database directory. Default: data
21+
-b, --backupDir <path> backup directory. Default: backup
22+
-c, --columnFamilies <cf1>,<cf2>...
23+
column families of the database (created if there is no db yet)
24+
```

0 commit comments

Comments
 (0)