diff --git a/README b/README index 509d24c6cd..3a231c84ab 100644 --- a/README +++ b/README @@ -1,6 +1,22 @@ -This is the new reddwarf lite goodness +Reddwarf +-------- -TODO:: +Reddwarf is Database as a Service for Open Stack. +To run all tests and PEP8, run tox, like so: +$ tox +To quickly run the tests for Python 2.7, run: +$ tox -epy27 + +To generate a coverage report,run: +$ tox -ecover +(note: on some boxes, the results may not be accurate unless you run it twice) + +If you'd like to start up a fake Reddwarf API daemon for integration testing +with your own tool, run: +$ ./bin/start_server + +Stop the server with: +$ ./bin/stop_server