From 9292900afc955e30060c06b24eda81188f04c939 Mon Sep 17 00:00:00 2001 From: Justin Li Date: Wed, 23 Jul 2014 15:43:15 -0400 Subject: [PATCH] Update readme to include new features --- README.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 008b24b..88ad3a8 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,15 @@ # 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 not be used in production. +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. Features include: -- Light resource consumption, and fast, asynchronous request processing -- Full compatibility with what exists of the BitTorrent spec -- Correct IPv6 support +- Low resource consumption, and fast, asynchronous request processing +- Full IPv6 support, including handling for dual-stacked peers - Generic storage interfaces that are easily adapted to work with any database - -### Technical Details - -See [the wiki](https://github.com/chihaya/chihaya/wiki) for a discussion of the design behind Chihaya. +- Full compatibility with what exists of the BitTorrent spec +- Extensive metrics for visibility into the tracker and swarm's performance +- Ability to group peers in local subnets to reduce backbone contention ## Using Chihaya @@ -44,6 +42,10 @@ $ cd $GOPATH/src/github.com/chihaya/chihaya $ go test -v ./... ``` +### Technical Details + +See [the wiki](https://github.com/chihaya/chihaya/wiki) for a discussion of the design behind Chihaya. + ## Drivers Chihaya is designed to remain agnostic about the choice of data store for an