clean up examples

travisjeffery · Jan 24, 2017 · 3bf02b3 · 3bf02b3
1 parent 5a63de5
commit 3bf02b3
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 16 deletions.
diff --git a/example/README.md b/example/README.md
diff --git a/quickstart.md → examples/cluster/README.md b/quickstart.md → examples/cluster/README.md
@@ -1,11 +1,11 @@
-# Quick start
+# Jocko cluster example
 
-This will start up a local three node cluster.
+This will start a local three node cluster.
 
 ## Build
 
 ```bash
-$ go get
+$ go get github.com/travisjeffery/jocko
 $ cd $GOPATH/src/github.com/travisjeffery/jocko/cmd/jocko
 $ go build
 ```
@@ -21,6 +21,7 @@ $ ./jocko --debug \
           --raftport=8001 \
           --serfport=7946 \
           --id=1
+
 $ ./jocko --debug \
           --logdir="/tmp/jocko2" \
           --tcpaddr=127.0.0.1:9002 \
@@ -30,6 +31,7 @@ $ ./jocko --debug \
           --serfport=7947 \
           --serfmembers=127.0.0.1:7946 \
           --id=2
+
 $ ./jocko --debug \
           --logdir="/tmp/jocko3" \
           --tcpaddr=127.0.0.1:9003 \

diff --git a/examples/sarama/README.md b/examples/sarama/README.md
@@ -0,0 +1,18 @@
+# Jocko used with a Sarama client example
+
+This example shows Sarama producing and consuming with Jocko.
+
+## Setup
+
+```
+$ go get github.com/travisjeffery/jocko
+$ cd $GOPATH/src/github.com/travisjeffery/jocko/examples/sarama
+```
+
+## Run
+
+```
+$ go run main.go
+```
+
+
diff --git a/example/main.go → examples/sarama/main.go b/example/main.go → examples/sarama/main.go