Adjust README

Author: cburgdorf

README.md

@@ -1,20 +1,109 @@
 # Dopple
 
-This Python script (found in `dopple.py`) provides HTTP proxy to Unix Socket based JSON-RPC servers.
-Check out --help option for more information.
+HTTP proxy to Unix Socket based JSON-RPC servers
+
+## Installation
+
+```sh
+pip install dopple
+```
 
 ## Use
 
-```bash
-dopple.py ~/.ethereum/geth.ipc http://127.0.0.1:8545
+```sh
+dopple ~/.ethereum/geth.ipc http://127.0.0.1:8545
+```
+
+Alternatively, `dopple` can be invoked as a pure script without installation:
+
+```sh
+./dopple/dopple.py ~/.ethereum/geth.ipc http://127.0.0.1:8545
 ```
 
 These values above are the default ones too. If they match your current configuration, they can be ommitted.
 
-## Maintainers
+Check out `--help` option for more information.
 
-Looking for maintainers! [Please state your interest here.](https://github.com/ethereum/dopple/issues/1)
+Read more in the [documentation on ReadTheDocs](https://dopple.readthedocs.io/). [View the change log](https://dopple.readthedocs.io/en/latest/releases.html).
 
 ## License
 
 Apache-2.0
+
+## Developer Setup
+
+If you would like to hack on dopple, please check out the [Snake Charmers
+Tactical Manual](https://github.com/ethereum/snake-charmers-tactical-manual)
+for information on how we do:
+
+- Testing
+- Pull Requests
+- Code Style
+- Documentation
+
+### Development Environment Setup
+
+You can set up your dev environment with:
+
+```sh
+git clone [email protected]:ethereum/dopple.git
+cd dopple
+virtualenv -p python3 venv
+. venv/bin/activate
+pip install -e .[dev]
+```
+
+### Testing Setup
+
+During development, you might like to have tests run on every file save.
+
+Show flake8 errors on file change:
+
+```sh
+# Test flake8
+when-changed -v -s -r -1 dopple/ tests/ -c "clear; flake8 dopple tests && echo 'flake8 success' || echo 'error'"
+```
+
+Run multi-process tests in one command, but without color:
+
+```sh
+# in the project root:
+pytest --numprocesses=4 --looponfail --maxfail=1
+# the same thing, succinctly:
+pytest -n 4 -f --maxfail=1
+```
+
+Run in one thread, with color and desktop notifications:
+
+```sh
+cd venv
+ptw --onfail "notify-send -t 5000 'Test failure ⚠⚠⚠⚠⚠' 'python 3 test on dopple failed'" ../tests ../dopple
+```
+
+### Release setup
+
+For Debian-like systems:
+```
+apt install pandoc
+```
+
+To release a new version:
+
+```sh
+make release bump=$$VERSION_PART_TO_BUMP$$
+```
+
+#### How to bumpversion
+
+The version format for this repo is `{major}.{minor}.{patch}` for stable, and
+`{major}.{minor}.{patch}-{stage}.{devnum}` for unstable (`stage` can be alpha or beta).
+
+To issue the next version in line, specify which part to bump,
+like `make release bump=minor` or `make release bump=devnum`. This is typically done from the
+master branch, except when releasing a beta (in which case the beta is released from master,
+and the previous stable branch is released from said branch).
+
+If you are in a beta version, `make release bump=stage` will switch to a stable.
+
+To issue an unstable version when the current version is stable, specify the
+new version explicitly, like `make release bump="--new-version 4.0.0-alpha.1 devnum"`