docs(readme.md): update README

#76

README.md

@@ -12,21 +12,18 @@ This project will answer the following questions:
 ### Security
 Monitored with Snyk
 [![Known Vulnerabilities](https://snyk.io/test/github/FiddlersCode/leopold/badge.svg?targetFile=package.json)](https://snyk.io/test/github/FiddlersCode/leopold?targetFile=package.json)
+
 Snyk continuously scans the GitHub repo for vulnerabilities and upgrades, and automatically generates
 a pull request when an upgrade is found (see https://github.com/FiddlersCode/leopold/pull/53).
 
 ### Local Dev:
 `npm run dev` will run the code locally.
 
-Currently broken due to Mongo Docker issue: https://github.com/FiddlersCode/leopold/issues/65
-
-### Commit/Push/Merge/Deploying
-See info below under contributing.
-
 ## Contributing to Leopold
-Contributions are very welcome to this repo! 
 [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](code_of_conduct.md)
-In making a contribution, you agree to abide by the Code of Conduct (./CODE_OF_CONDUCT.md) 
+
+Contributions are very welcome to this repo! 
+ In making a contribution, you agree to abide by the Code of Conduct (./CODE_OF_CONDUCT.md) 
 
 Please take a moment to read the philosophy of development, as it might be a bit different to what you're used to doing.
 
@@ -36,18 +33,19 @@ It can feel like a hassle at first, but it's designed to get your code up and ru
 users as quickly and safely as possible. I suggest working in [pomodoros](https://francescocirillo.com/pages/pomodoro-technique)
 and getting up and walking outside on the 5-minute breaks.
 
-This repo is written with TDD - see more below and please continue to contribute with this practice!
+This repo is written with TDD - see more below and please continue to contribute using this practice!
 
 ### Automated Tooling
 #### Setup
-- You can run the `dev-setup.sh` script which will create your development environment.
+- Mac users can can run the `dev-setup.sh` script which will create your development environment.
 
    - Copies the .env template file
    - Installs the [Circle CI CLI](https://circleci.com/docs/2.0/local-cli/) (required for pre-commit checks) 
 Improvements to this script are https://github.com/FiddlersCode/leopold/issues/32
+   - Installs Mongo via `homebrew`
 - When developing locally, use a feature branch with the format `issue-NN`, where the issue links to the relevant GitHub issue.
 
-Alternatively, you can run these steps manually. (They have only been tested on a Mac so Windows users may experience issues with the script.)
+Alternatively, you can run these steps manually. (They have only been tested on a Mac so Windows/Linux users may experience issues with the script.)
 
 #### Troubleshooting
 - Mongo connection errors? `brew services restart mongodb-community`
@@ -59,13 +57,12 @@ so your message passed with the `-m` flag will be lost.
 
 When you attempt a commit, the following checks will be run:
 - `npm run ci-validate`: this validates the `.circleci/config.yml` file
-- `npm run lint-dev`: this will run `eslint` and automatically fix whatever errors it can (NB you will still need to commit any changed files). 
+- `npm run lint-dev`: this will run `eslint` and automatically fix whatever errors it can (NB you will still need to commit any changed files).
 - `npm run test`: this will run all tests using Jest. The commit will fail if any tests fail. You will need to fix the broken test(s) and re-commit.
 - `npm run test` also runs Jest's coverage tool.
 Your commit will fail if the coverage falls below the parameters defined in `jest.config.js`
 
 Not yet implemented:
- - a script will check for the correct branch name and commit message format (see setup above) https://github.com/FiddlersCode/leopold/issues/34
 - An improvement to add the `linted` files to staging and re-attempt the commit is here https://github.com/FiddlersCode/leopold/issues/7
 
 #### Commit Message
@@ -79,7 +76,7 @@ At the moment, no further checks are run at this stage.
 
 Possible checks to be run in the future:
 - `npm run healthcheck-ci`: this brings up the Docker stack locally and checks that it's running
-- `npm run test-ci`: this runs all of the tests against the Docker stack 
+- `npm run test-ci`: this runs some/all of the tests against the Docker stack 
 (e.g. the Mongo tests which run against an in-memory database will now run against the Mongo container to check networking)
 
 #### CI/CD Stage
@@ -91,20 +88,20 @@ While the build is running on Circle CI, Snyk is also running a security monitor
 In order for a PR to be marked as "able to be merged", the following must be true:
 - `Snyk` security scan has come back clean
 - Branch build has succeeded on Circle CI.
+- dry-run release to Docker Hub has succeeded (using `semantic-release`)
 
 Upon merge, a build will be kicked off on Circle CI's `develop` branch. 
-If the build passes, the built Docker image will be tagged and pushed to Docker hub.
+If the build passes, the built Docker image will be tagged with a semantic version and pushed to Docker hub.
 Tags are created by `semantic-release`, and are based on the style-enforced commit message.
 
-Not yet implemented:
-- automatic generation of changelogs based on your commit messages
+A changelog is automatically generated based on your commit messages.
 
 The image is then available to download to any servers that require an update.
 
 #### GitHub Remote Configuration
 The following checks are in place for the remote repo:
 - protected branches cannot be deleted
-- branches do not currently require a PR approval. I am the sole contributor and GitHub does not allow users
+- branches do not currently require a PR approval. I am currently the sole contributor and GitHub does not allow users
 to approve their own PRs so I would never be able to merge! 
 
 
@@ -113,7 +110,7 @@ The production server is a Raspberry Pi named Ginger Nuts sitting on my desk whi
 Once those have been resolved, the following ticket to implement a pull strategy
 for the Pi will be done: https://github.com/FiddlersCode/leopold/issues/64
 
-Following issue 64, as soon as the build is completed on the production server, a series of service health checks will be run
+Following issue 64, as soon as the build is completed on the production server, a series of service health checks will be run.
 If these healthchecks fail, the merge will be immediately reverted.
 https://github.com/FiddlersCode/leopold/issues/36