summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 23 insertions, 3 deletions
diff --git a/README.md b/README.md
index 7b6f47c..73894d1 100644
--- a/README.md
+++ b/README.md
@@ -12,14 +12,34 @@ Copyright 2012, David Arthur under Apache License, v2.0. See `LICENSE`
This project is very much alpha. The API is in flux and not all the features are fully implemented.
-# Usage
+# Tests
+
+## Run the unit tests
+
+```shell
+python -m test.unit
+```
+
+## Run the integration tests
-## Run the tests
+First, checkout the Kafka source
```shell
-python -m unittest -v test
+git submodule init
+git submodule update
+cd kafka-src
+./sbt update
+./sbt package
```
+Then from the root directory, run the integration tests
+
+```shell
+python -m test.integration
+```
+
+# Usage
+
## Send a message to a topic
You need to specify the topic and partition