readme: basic getting started
[skip ci]
This commit is contained in:
parent
bd720b692c
commit
dfcc04b38b
1 changed files with 15 additions and 4 deletions
19
README.md
19
README.md
|
@ -11,25 +11,36 @@ Chihaya is an open source [BitTorrent tracker] written in [Go].
|
||||||
|
|
||||||
Differentiating features include:
|
Differentiating features include:
|
||||||
|
|
||||||
- Extensible, middleware-oriented request flow that is customized in a [YAML] configuration file
|
- Protocol-agnostic and middleware-composed logic
|
||||||
- Low resource consumption, and fast, asynchronous request processing
|
- Low resource consumption and fast, asynchronous request processing
|
||||||
- Unified IPv4 and IPv6 support
|
- Unified IPv4 and IPv6 [swarms]
|
||||||
|
- [YAML] configuration
|
||||||
|
- Optional metrics via [Prometheus]
|
||||||
|
|
||||||
[BitTorrent tracker]: http://en.wikipedia.org/wiki/BitTorrent_tracker
|
[BitTorrent tracker]: http://en.wikipedia.org/wiki/BitTorrent_tracker
|
||||||
[Go]: https://golang.org
|
[Go]: https://golang.org
|
||||||
|
[swarms]: https://en.wikipedia.org/wiki/Glossary_of_BitTorrent_terms#Swarm
|
||||||
[YAML]: http://yaml.org
|
[YAML]: http://yaml.org
|
||||||
|
[Prometheus]: http://prometheus.io
|
||||||
|
|
||||||
## Getting Started
|
## Getting Started
|
||||||
|
|
||||||
TODO(jzelinskie): I should fill this section in
|
In order to compile the project, the latest stable version of Go and a working Go environment are required.
|
||||||
|
|
||||||
|
```sh
|
||||||
|
$ go get github.com/chihaya/chihaya
|
||||||
|
$ go install github.com/chihaya/chihaya/cmd/chihaya
|
||||||
|
```
|
||||||
|
|
||||||
## Development
|
## Development
|
||||||
|
|
||||||
Long-term discussion and bug reports are maintained via [GitHub Issues].
|
Long-term discussion and bug reports are maintained via [GitHub Issues].
|
||||||
Code review is done via [GitHub Pull Requests].
|
Code review is done via [GitHub Pull Requests].
|
||||||
|
Real-time discussion is done via [freenode IRC].
|
||||||
|
|
||||||
[GitHub Issues]: https://github.com/chihaya/chihaya/issues
|
[GitHub Issues]: https://github.com/chihaya/chihaya/issues
|
||||||
[GitHub Pull Requests]: https://github.com/chihaya/chihaya/pulls
|
[GitHub Pull Requests]: https://github.com/chihaya/chihaya/pulls
|
||||||
|
[freenode IRC]: http://webchat.freenode.net/?channels=chihaya
|
||||||
|
|
||||||
## Related projects
|
## Related projects
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue