LBRYCommunity/tracker
1
0
Fork 0
Code Issues 1 Pull requests Projects Releases Packages Wiki Activity

Format the readme more

Browse source 
[ci skip]
This commit is contained in:
Justin Li 2013-08-29 21:48:48 -04:00
parent 5f3c57cb92
commit a9f5420715
1 changed files with 16 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
README.md
View file

@ -2,7 +2,9 @@
Chihaya is a high-performance [BitTorrent tracker](http://en.wikipedia.org/wiki/BitTorrent_tracker) Chihaya is a high-performance [BitTorrent tracker](http://en.wikipedia.org/wiki/BitTorrent_tracker)
written in the Go programming language. It is still heavily under development and the current `master` branch written in the Go programming language. It is still heavily under development and the current `master` branch
should not be used in production. Planned features include: should not be used in production.
Planned features include:
- Light resource consumption - Light resource consumption
- Fast request processing, sparing the network from exorbitant connection counts - Fast request processing, sparing the network from exorbitant connection counts
@ -11,19 +13,26 @@ should not be used in production. Planned features include:
- Generic storage interfaces that are easily adapted to work with any existing web application - Generic storage interfaces that are easily adapted to work with any existing web application
- Scaling properties that directly correlate with those of the chosen data stores - Scaling properties that directly correlate with those of the chosen data stores
## Technical Details ### Technical Details
See [the wiki](https://github.com/pushrax/chihaya/wiki) for a discussion of the design behind Chihaya. See [the wiki](https://github.com/pushrax/chihaya/wiki) for a discussion of the design behind Chihaya.
## Installing ## Using Chihaya
### Installing
Make sure you have your $GOROOT and $GOPATH set up correctly and have your $GOBIN on your $PATH. Make sure you have your `$GOROOT` and `$GOPATH` set up correctly, and have your `$GOBIN` in your `$PATH`.
```sh ```sh
$ go get github.com/pushrax/chihaya $ go get github.com/pushrax/chihaya
``` ```
## Testing ### Configuring
Configuration is done in a JSON formatted file specified with the `-config`
flag. An example configuration file can be found
[here](https://github.com/pushrax/chihaya/blob/master/config/example.json).
### Running the tests
```sh ```sh
$ export TESTCONFIGPATH=$GOPATH/src/chihaya/config/example.json $ export TESTCONFIGPATH=$GOPATH/src/chihaya/config/example.json
@ -31,12 +40,6 @@ $ go get github.com/pushrax/chihaya
$ go test -v ./... $ go test -v ./...
``` ```
## Configuring
Configuration is done in a JSON formatted file specified with the `-config`
flag. An example configuration file can be found
[here](https://github.com/pushrax/chihaya/blob/master/config/example.json).
## Default drivers ## Default drivers
Chihaya is designed to remain agnostic about the choice of data store for an Chihaya is designed to remain agnostic about the choice of data store for an
@ -45,8 +48,8 @@ are a number of directly supported drivers:
Cache: Cache:
* [redis](http://redis.io) * [redis](http://redis.io) — allows for multiple tracker instances to run at the same time for the same swarm
* Memory * memory — only a single instance can run, but it requires no extra setup
Storage: Storage: