From c8f49d226c49a1f6fa1a58b986a92f732ada2ff5 Mon Sep 17 00:00:00 2001 From: Eric Santos Date: Mon, 3 Dec 2018 19:38:51 -0400 Subject: [PATCH] chore(docs): added content to README --- README.md | 22 +++++++++++++++++----- example.env | 6 ++++-- 2 files changed, 21 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index d3a4d88..5df4cce 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,28 @@ # GoTenatious Mesh Dashboard + GoTenatious Mesh emergency feed dashboard ## Requirements + - [Docker](https://www.docker.com/) ## Setup -- Copy `example.env` as `.env` -- Add `MONGO_HOSTNAME` value -- Add `BASE_URL` value -- `make build` +1. Copy `example.env` as `.env` +2. Add `MONGO_HOSTNAME` value +3. Add `BASE_URL` value +4. Add `DB_NAME` value +5. Add `PORT` value +6. Run `make build` ## Run -- `make up` +To run the app do: `make up` + +## Contributing + +1. Fork it ( https://github.com/[my-github-username]/dashboard/fork ) +2. Create your feature branch (git checkout -b feature/my_new_feature) +3. Commit your changes (git commit -am 'Add some feature') +4. Push to the branch (git push origin my-new-feature) +5. Create a new Pull Request \ No newline at end of file diff --git a/example.env b/example.env index 48cd3c9..18cca48 100644 --- a/example.env +++ b/example.env @@ -1,2 +1,4 @@ -MONGO_HOSTNAME= -BASE_URL= \ No newline at end of file +PORT= +DB_NAME= +BASE_URL= +MONGO_HOSTNAME= \ No newline at end of file