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

docs: attempt to keep README within 80 chars

Browse source 
[skip ci]
This commit is contained in:
Jimmy Zelinskie 2015-01-28 23:26:03 -05:00
parent 347eb2d256
commit 9a4f1a5d2d
1 changed files with 15 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
README.md
View file

@ -1,6 +1,9 @@
# Chihaya [![Build Status](https://api.travis-ci.org/chihaya/chihaya.svg?branch=master)](https://travis-ci.org/chihaya/chihaya) # Chihaya [![Build Status](https://api.travis-ci.org/chihaya/chihaya.svg?branch=master)](https://travis-ci.org/chihaya/chihaya)
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 should probably not be used in production (unless you know what you're doing). Chihaya is a high-performance [BitTorrent tracker] written in the Go
programming language. It is still heavily under development and the current
`master` branch should probably not be used in production
(unless you know what you're doing).
Features include: Features include:
@ -12,11 +15,17 @@ Features include:
- Ability to prioritize peers in local subnets to reduce backbone contention - Ability to prioritize peers in local subnets to reduce backbone contention
- Pluggable backend driver that can coordinate with an external database - Pluggable backend driver that can coordinate with an external database
[BitTorrent tracker]: http://en.wikipedia.org/wiki/BitTorrent_tracker
[gazelle]: https://github.com/whatcd/gazelle [gazelle]: https://github.com/whatcd/gazelle
## When would I use Chihaya? ## When would I use Chihaya?
Chihaya is a meant for every kind of BitTorrent tracker deployment. Chihaya has been used to replace instances of [opentracker] and also instances of [ocelot]. Chihaya handles torrent announces and scrapes in memory, but using a backend driver, can also asynchronously provide deltas to maintain a set of persistent data without throttling a database (this most useful for private tracker use-cases). Chihaya is a meant for every kind of BitTorrent tracker deployment. Chihaya has
been used to replace instances of [opentracker] and also instances of [ocelot].
Chihaya handles torrent announces and scrapes in memory, but using a backend
driver, can also asynchronously provide deltas to maintain a set of persistent
data without throttling a database (this most useful for private tracker
use-cases).
[opentracker]: http://erdgeist.org/arts/software/opentracker [opentracker]: http://erdgeist.org/arts/software/opentracker
[ocelot]: https://github.com/WhatCD/Ocelot [ocelot]: https://github.com/WhatCD/Ocelot
@ -36,14 +45,16 @@ $ godep go install chihaya/src/github.com/chihaya/cmd/chihaya
## Testing ## Testing
Chihaya has end-to-end test coverage for announces in addition to unit tests for isolated components. To run the tests, use: 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
$ godep go test -v ./... $ godep go test -v ./...
``` ```
There is also a set of benchmarks for performance-critical sections of Chihaya. These can be run similarly: There is also a set of benchmarks for performance-critical sections of Chihaya.
These can be run similarly:
```sh ```sh
$ cd $GOPATH/src/github.com/chihaya/chihaya $ cd $GOPATH/src/github.com/chihaya/chihaya