update readme

README.md

@@ -2,14 +2,32 @@
 
 API which returns people who are listed as either living in London, or whose current coordinates are within 50 miles of London.
 
+## Getting Started
+
+If you have docker installed, you can run `docker-compose up` to build and run the app.
+
+Alternatively, you can run locally without redis:
+
+1. `npm i`
+2. `npm run dev`
+
+### Running Tests
+
+`npm run test`
+
 ## Technical Considerations
 
-- API Documentation :negative_squared_cross_mark:
+- API Documentation :x:
+  - Swagger considered but there is no API contract and the endpoint is already simple enough
 - Caching :white_check_mark:
 - Circuit Breaker :white_check_mark:
 - Docker :white_check_mark:
 - Error Handling :white_check_mark:
-- Logging :negative_squared_cross_mark:
-- OWASP :negative_squared_cross_mark:
-- Process manager :negative_squared_cross_mark:
+- Logging :x:
+  - Would implement Winston when necessary
+- OWASP :x:
+  - No API Contract specified but if in production could consider an API Key and Rate limiting
+- Process manager :x:
+  - PM2 considered but was not part of requirements
 - Twelve Factor App :eight_spoked_asterisk:
+  - Has been considered and relevant practices applied

package.json

@@ -6,7 +6,8 @@
   "scripts": {
     "build": "rimraf app && babel src -d app",
     "start": "npm run build && node app",
-    "dev": "nodemon --exec npm run restart"
+    "dev": "nodemon --exec npm run restart",
+    "test": "jest"
   },
   "author": "",
   "license": "ISC",