From bbba71a9c36259493969891dc31680d72ec01df6 Mon Sep 17 00:00:00 2001 From: Knut Ahlers Date: Wed, 7 Aug 2019 08:14:42 +0200 Subject: [PATCH] Add Usage Signed-off-by: Knut Ahlers --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index 3c44da6..84d66b0 100644 --- a/README.md +++ b/README.md @@ -11,3 +11,21 @@ The goal of this project was to have a small application to be deployed without any dependencies to open a Wiki for note taking or documentation purpose. The software itself has no concept of users or authentication and is held as simple as possible. Saved pages are stored as plain Markdown file onto the local disk inside a Git repository which on the one hand can be used to backup the state (just add a remote and set up a cron to push changes) and on the other hand to recover contents if someone deleted contents from a page. + +## Usage + +```console +# wiki --help +Usage of wiki: + --data-dir string Directory to store data to (default "./data/") + --listen string Port/IP to listen on (default ":3000") + --log-level string Log level (debug, info, warn, error, fatal) (default "info") + --version Prints current version and exits +``` + +To use this you can +- download pre-build binaries from the [releases](https://github.com/Luzifer/wiki/releases) +- pull the [Docker image](https://hub.docker.com/r/luzifer/wiki) +- or `go get -u github.com/Luzifer/wiki` the project + +Given you've used the binary you can now just execute `./wiki` and go to `http://localhost:3000`. Everything you save will be stored in the `./data` directory.