diff --git a/README.md b/README.md index d83f7f4..49919da 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ An API centric chat server. Uses Sequelize and mariaDB by default. # Setup -TODO: document the chat server setup +There are multiple ways to run this app - it can run on it's own via `npm start` (for production) or `npm run dev` (for development). it can also run inside docker using `docker-compose up --build` - run `node configure-script.js` to generate docker-compose.yml. # API