diff --git a/README.md b/README.md new file mode 100644 index 0000000..cce7dd1 --- /dev/null +++ b/README.md @@ -0,0 +1,40 @@ +# Chihaya + +[![Build Status](https://api.travis-ci.org/chihaya/chihaya.svg?branch=master)](https://travis-ci.org/chihaya/chihaya) +[![Docker Repository on Quay.io](https://quay.io/repository/jzelinskie/chihaya/status "Docker Repository on Quay.io")](https://quay.io/repository/jzelinskie/chihaya) +[![GoDoc](https://godoc.org/github.com/chihaya/chihaya?status.svg)](https://godoc.org/github.com/chihaya/chihaya) +[![License](https://img.shields.io/badge/license-BSD-blue.svg)](https://en.wikipedia.org/wiki/BSD_licenses#2-clause_license_.28.22Simplified_BSD_License.22_or_.22FreeBSD_License.22.29) +[![IRC Channel](https://img.shields.io/badge/freenode-%23chihaya-blue.svg "IRC Channel")](http://webchat.freenode.net/?channels=chihaya) + +Chihaya is an open source [BitTorrent tracker] written in [Go]. + +Differentiating features include: + +- Extensible, middleware-oriented request flow that is customized in a [YAML] configuration file +- Low resource consumption, and fast, asynchronous request processing +- Unified IPv4 and IPv6 support + +[BitTorrent tracker]: http://en.wikipedia.org/wiki/BitTorrent_tracker +[Go]: https://golang.org +[YAML]: http://yaml.org + +## Getting Started + +TODO(jzelinskie): I should fill this section in + +## Development + +Long-term discussion and bug reports are maintained via [GitHub Issues]. +Code review is done via [GitHub Pull Requests]. + +[GitHub Issues]: https://github.com/chihaya/chihaya/issues +[GitHub Pull Requests]: https://github.com/chihaya/chihaya/pulls + +## Related projects + +- [OpenTracker](http://erdgeist.org/arts/software/opentracker): a popular BitTorrent tracker written in C +- [Ocelot](https://github.com/WhatCD/Ocelot): a private BitTorrent tracker written in C++ + +## License + +Chihaya is distributed under the 2-Clause BSD license that can be found in the `LICENSE` file.