add ReadMe

This commit is contained in:
Paul Liverman III 2018-04-24 10:02:08 -07:00
parent 24302c39d4
commit e6128a063a

13
ReadMe.md Normal file
View File

@ -0,0 +1,13 @@
# Simplex
An extremely simple task management API.
## Installation
For development, simply run `./install.sh dev`. This will install necessary
prerequisites. Run `lapis server production` to start the server and `lapis term`
to stop it.
For production, make sure a domain name is pointed at the server's IP address,
then run `./install.sh`. This will install the necessary prerequisites and start
the server as a service.