dlss
/
FedP2P
4
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Improve the README

This commit is contained in:
Matt Joiner 2015-03-20 23:18:09 +11:00
parent 231c8b9419
commit 73d8eef468
2 changed files with 28 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
README.md Normal file
View File

@ -0,0 +1,28 @@
# torrent
[![Codeship](https://www.codeship.io/projects/a2811d30-b0ce-0132-8983-5e604f7ebe37/status)](https://codeship.com/projects/69674)
[![GoDoc](https://godoc.org/github.com/anacrolix/torrent?status.svg)](https://godoc.org/github.com/anacrolix/torrent)
This repository implements BitTorrent-related packages and command-line utilities in Go.
There is support for protocol encryption, DHT, PEX, uTP, and various extensions. There are several storage backends provided, blob, file, mmap. You can use the provided binaries in `./cmd`, or use `torrent` as a library for your own applications.
## Installation
Install the library package with `go get github.com/anacrolix/torrent`, or one of the provided cmds with `go get github.com/anacrolix/...`.
## Library example
There is a small example in the [package documentation](https://godoc.org/github.com/anacrolix/torrent).
## Torrent utility
There's a provided utility that downloads torrents from the command-line.
$ go get github.com/anacrolix/torrent/cmd/torrent
$ torrent 'magnet:?xt=urn:btih:ZOCMZQIPFFW7OLLMIC5HUB6BPCSDEOQU'
2015/03/20 22:51:41 main.go:96: downloaded ALL the torrents
$ md5sum ubuntu-14.04.1-desktop-amd64.iso
119cb63b48c9a18f31f417f09655efbd ubuntu-14.04.1-desktop-amd64.iso
$ echo such amaze
wow

1
README.rst
View File

@ -1 +0,0 @@
.. image:: https://www.codeship.io/projects/a2811d30-b0ce-0132-8983-5e604f7ebe37/status