Add better README.md with instructions for how to use Ekster

This commit is contained in:
Peter Stuifzand 2018-05-16 17:40:57 +02:00
parent ff0e969d8f
commit ec33521111

View File

@ -3,4 +3,34 @@
a microsub server
## Warning!
Very alpha: no warranty.
## Install ekster
ekster is build using [go](https://golang.org). To be able to install ekster
you need a Go environment. Use these commands to install the programs.
go get -u github.com/pstuifzand/ekster/cmd/eksterd
go get -u github.com/pstuifzand/ekster/cmd/ek
### `eksterd`
The command `eksterd` is the main server program. It will run a Microsub server.
`eksterd` also needs a Redis server. It's used to temporarily remember the items.
The first time you should call the command
eksterd new
This will generate a configuration file where it remembers the feeds.
### `ek`
The command `ek` is the command line client for Microsub server. It is able to
call the different functions of the Microsub server. It isn't needed to use `eksterd`, but
it can be useful. It can also be used with other servers that implement Microsub.