Stream line install and config docs (#152)

* first pass

* remove unused

* fix typos

* update docs

* remove secondary config method

* add nix shell

* fix tags

* remove command line shell script

* fail loudly without .env

* debug logs

* fix quiet mode

* add warning and feedback

* typos

Author: jackkav

.env.sample

@@ -1,3 +1,3 @@
-MOCKBIN_PORT=8080,
+MOCKBIN_PORT=8080
 MOCKBIN_QUIET=false
 MOCKBIN_REDIS=redis://127.0.0.1:6379

.travis.yml

@@ -1,8 +1,5 @@
-# Mockbin [![version][npm-version]][npm-url] [![License][npm-license]][license-url]
+# Mockbin ![version][npm-version] [![License][npm-license]][license-url]
 
-[![Build Status][travis-image]][travis-url]
-[![Downloads][npm-downloads]][npm-url]
-[![Dependencies][david-image]][david-url]
 [![Gitter][gitter-image]][gitter-url]
 
 Mockbin is used internally and maintained by [Kong](https://github.com/Kong), who also maintain the open-source API Gateway [Kong](https://github.com/Kong/kong).
@@ -11,12 +8,9 @@ Mockbin is used internally and maintained by [Kong](https://github.com/Kong), wh
 
 - [Features](#features)
 - [Installation](#installation)
-  - [Heroku](#heroku)
-  - [Docker](#docker)
   - [Requirements](#requirements)
-  - [Configuration](#configuration)
-  - [Running](#running)
-- [Usage](#usage)
+  - [Running with Node](#running-with-node)
+  - [Running with Docker Compose](#running-with-docker-compose)
 - [Documentation](#documentation)
 - [Bugs and feature requests](#bugs-and-feature-requests)
 - [Contributing](#contributing)
@@ -32,68 +26,44 @@ Mockbin is used internally and maintained by [Kong](https://github.com/Kong), wh
 
 ## Installation
 
-install from source or through [npm](https://www.npmjs.com/):
-
 ```shell
-npm install mockbin
+git clone https://github.com/Kong/mockbin.git ./mockbin
+cd mockbin
+cp .env.sample .env
+brew install fnm
+fnm use
+npm install
 ```
 
-### Heroku
-
-[![Deploy][docker-image]][docker-url]
-
-*read more on [Installation](docs/install.md)*.
-
-### Docker
-
-[![Docker][docker-logo]](docs/install.md#install-with-docker)
-
-*read more on [Installation](docs/install.md#install-with-docker)*.
+Note: nvm, n or volta can be used instead of fnm.
 
 ### Requirements
 
 other than the dependencies listed in [package.json](package.json) The following are required:
 
 - [Redis](http://redis.io/)
 
-### Configuration
-
-you will need to tell *mockbin* where Redis is:
-
-```shell
-npm config set mockbin:redis redis://127.0.0.1:6379
-```
-
-By Default the server will run on port `8080`, you can customize the port like so:
-
 ```shell
-npm config set mockbin:port 8001
+brew install redis
+brew services start redis
 ```
 
-*read more on [Configuration](docs/config.md)*.
-
-### Running
+Redis should be now running on localhost:6379
 
-After installing the `npm` package you can now start the server like so:
+### Running with Node
 
 ```shell
 npm start
-NODE_DEBUG=mockbin npm run dev
+# OR watch for changes
+npm run dev
+# OR with debug logs
+DEBUG=mockbin npm run dev
 ```
 
-## Usage
+## Running with Docker Compose
 
 ```shell
-  Usage: mockbin [options]
-
-  Options:
-
-    -h, --help         output usage information
-    -V, --version      output the version number
-    -p, --port <port>  Port that the HTTP server will run on
-    -r, --redis [dsn]  Redis dsn
-    -q, --quiet        Disable console logging
-
+docker compose up
 ```
 
 ## Documentation
@@ -118,20 +88,7 @@ Editor preferences are available in the [editor config](.editorconfig) for easy
 
 [license-url]: https://github.com/Kong/mockbin/blob/master/LICENSE
 
-[travis-url]: https://travis-ci.org/Kong/mockbin
-[travis-image]: https://img.shields.io/travis/Kong/mockbin.svg?style=flat-square
-
-[npm-url]: https://www.npmjs.com/package/mockbin
 [npm-license]: https://img.shields.io/npm/l/mockbin.svg?style=flat-square
 [npm-version]: https://img.shields.io/npm/v/mockbin.svg?style=flat-square
-[npm-downloads]: https://img.shields.io/npm/dm/mockbin.svg?style=flat-square
-
-[david-url]: https://david-dm.org/Kong/mockbin
-[david-image]: https://img.shields.io/david/Kong/mockbin.svg?style=flat-square
-
-[docker-image]: https://www.herokucdn.com/deploy/button.svg
-[docker-url]: https://heroku.com/deploy?template=https://github.com/Kong/mockbin
-[docker-logo]: https://d3oypxn00j2a10.cloudfront.net/0.16.0/images/pages/brand_guidelines/small_h.png
-
 [gitter-url]: https://gitter.im/Kong/mockbin
 [gitter-image]: https://img.shields.io/badge/Gitter-Join%20Chat-blue.svg?style=flat-square

Procfile

@@ -2,7 +2,6 @@ services:
   app:
     build: .
     environment:
-      REALM: prod
       REDIS_URL: "//redis:6379"
     links:
       - redis

README.md

@@ -91,6 +91,86 @@ Responds with a `Location` header with the newly created **Bin**, e.g. `Location
 
 ----
 
+#### Update Bin
+
+> ##### `PUT /bin/:id`
+
+Updates a new **Bin** with a mock HTTP response as described by a [HAR Response Object](http://www.softwareishard.com/blog/har-12-spec/#response) body.
+
+Responds with a `Location` header with the updated **Bin**, e.g. `Location: /bin/3c149e20-bc9c-4c68-8614-048e6023a108` *(the Bin ID is also repeated in the body)*
+
+###### Request
+
+> ```http
+> PUT /bin/3c149e20-bc9c-4c68-8614-048e6023a108 HTTP/1.1
+> Host: mockbin.org
+> Content-Type: application/json
+> Accept: application/json
+> Content-Length: 819
+>
+> {
+>   "status": 200,
+>   "statusText": "OK",
+>   "httpVersion": "HTTP/1.1",
+>   "headers": [
+>     {
+>       "name": "Date",
+>       "value": "Wed, 21 Jan 2015 23:36:35 GMT"
+>     },
+>     {
+>       "name": "Server",
+>       "value": "Apache"
+>     },
+>     {
+>       "name": "Transfer-Encoding",
+>       "value": "chunked"
+>     },
+>     {
+>       "name": "Content-Type",
+>       "value": "text/html; charset=UTF-8"
+>     },
+>     {
+>       "name": "Cache-Control",
+>       "value": "max-age=7200"
+>     },
+>     {
+>       "name": "Connection",
+>       "value": "Keep-Alive"
+>     },
+>     {
+>       "name": "Keep-Alive",
+>       "value": "timeout=5, max=50"
+>     },
+>     {
+>       "name": "Expires",
+>       "value": "Thu, 22 Jan 2015 01:36:35 GMT"
+>     }
+>   ],
+>   "cookies": [],
+>   "content": {
+>     "size": 70972,
+>     "mimeType": "text/html",
+>     "compression": -21
+>   },
+>   "redirectURL": "",
+>   "headersSize": 323,
+>   "bodySize": 70993
+> }
+> ```
+
+###### Response
+
+> ```http
+> HTTP/1.1 200 OK
+> Location: /bin/3c149e20-bc9c-4c68-8614-048e6023a108
+> Content-Type: application/json; charset=utf-8
+> Content-Length: 38
+>
+> "3c149e20-bc9c-4c68-8614-048e6023a108"
+> ```
+
+----
+
 #### Inspect Bin
 
 > ##### `GET /bin/:id/view`

bin/mockbin

@@ -1,10 +1,10 @@
-## Overview 
+## Overview
 
 ### HTTP Methods
 
 **Unless otherwise indicated**: all Endpoints will accept *any* HTTP request with *any* header, using *any of the supported* HTTP Methods: `DELETE`, `GET`, `HEAD`, `POST`, `PUT`, `OPTIONS`, `TRACE`, `COPY`, `LOCK`, `MKCOL`, `MOVE`, `PROPFIND`, `PROPPATCH`, `SEARCH`, `UNLOCK`, `REPORT`, `MKACTIVITY`, `CHECKOUT`, `MERGE`, `M-SEARCH`, `NOTIFY`, `SUBSCRIBE`, `UNSUBSCRIBE`, `PATCH`, `PURGE`
 
-```
+```shell
 # GET
 curl mockbin.org/request