Permalink
Browse files

Updated the README.

  • Loading branch information...
1 parent e82d36e commit 8f7d1db981a2875ab70dc75b27bcab3e36119499 @snej snej committed Oct 6, 2011
Showing with 17 additions and 2 deletions.
  1. +17 −2 README.md
View
@@ -35,12 +35,26 @@ This project isn't quite standalone; it links against the Couchbase Mobile and C
### Build and run the app
1. Select the appropriate destination (an iOS device or simulator) from the pop-up menu in the Xcode toolbar.
-2. Click the Run button
+2. Click the Run button.
+
+Once in the app, you'll see a list of available tests. Tap the on/off switch next to a test to start or stop it. (Some tests stop automatically, some run forever till you stop them.)
+
+To see more info about a test, tap its name to navigate to its page. This will show the test's log output. You can also start and stop the test from this page. The test will keep running whether you're on its page or not.
+
+Test output is saved to the app's Documents directory. If you're running on a real device, you can access this directory by tethering the device, selecting it in iTunes, going to the Apps tab, scrolling down to the File Sharing list, then selecting "Worker Bee" in the list. In the simulator, you can look in the Xcode console output for lines starting with "** OPENING" to see the paths to the log files.
+
+## Adding Your Own Tests
+
+Just create a new subclass of BeeCouchTest. Read API docs for that class and its parent BeeTest to see what you can do, and look at the existing tests for inspiration.
+
+Generally you'll override -setUp, set a heartbeatInterval, and override -heartbeat to perform periodic activity. The framework takes care of creating a fresh database for you to work with.
## License
Portions under Apache, Erlang, and other licenses.
+Background pattern images are from [subtlepatterns.com][9], released under a Creative Commons Attribution 3.0 Unported License.
+
The overall package is released under the Apache license, 2.0.
Copyright 2011, Couchbase, Inc.
@@ -50,4 +64,5 @@ Copyright 2011, Couchbase, Inc.
[4]: https://groups.google.com/group/mobile-couchbase
[5]: https://github.com/couchbaselabs/CouchCocoa/downloads
[6]: https://github.com/couchbaselabs/CouchCocoa/
-[8]: https://github.com/couchbaselabs/WorkerBee/zipball/master
+[8]: https://github.com/couchbaselabs/WorkerBee/zipball/master
+[9]: http://subtlepatterns.com/

0 comments on commit 8f7d1db

Please sign in to comment.