diff --git a/ReadMe.md b/ReadMe.md new file mode 100644 index 0000000..cdf1cca --- /dev/null +++ b/ReadMe.md @@ -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.