From 4d906cf095229fd5b8d2705b2b9f9bfb1747f89d Mon Sep 17 00:00:00 2001 From: Justin Li Date: Thu, 24 Jul 2014 00:04:29 -0400 Subject: [PATCH] Add benchmark info to the README [ci skip] --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 2ae1fd0..e68a2cf 100644 --- a/README.md +++ b/README.md @@ -43,11 +43,20 @@ Chihaya is designed to remain agnostic about the choice of data storage. Out of ### Testing +Chihaya has end-to-end test coverage for announces in addition to unit tests for isolated components. To run the tests, use: + ```sh $ cd $GOPATH/src/github.com/chihaya/chihaya $ go test -v ./... ``` +There is also a set of benchmarks for performance-critical sections of Chihaya. These can be run similarly: + +```sh +$ cd $GOPATH/src/github.com/chihaya/chihaya +$ go test -v ./... -bench . +``` + ### Customizing Chihaya If you require more than the drivers provided out-of-the-box, you are free to create your own and then produce your own custom Chihaya binary. To create this binary, simply create your own main package, import your custom drivers, then call [`chihaya.Boot`] from main.