Add benchmark info to the README

[ci skip]
This commit is contained in:
Justin Li 2014-07-24 00:04:29 -04:00
parent 25e7ea98d5
commit 4d906cf095

View file

@ -43,11 +43,20 @@ Chihaya is designed to remain agnostic about the choice of data storage. Out of
### Testing ### Testing
Chihaya has end-to-end test coverage for announces in addition to unit tests for isolated components. To run the tests, use:
```sh ```sh
$ cd $GOPATH/src/github.com/chihaya/chihaya $ cd $GOPATH/src/github.com/chihaya/chihaya
$ go test -v ./... $ 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 ### 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. 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.