README.md

   1 # torrent
   2
   3 [![Join the chat at https://gitter.im/anacrolix/torrent](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/anacrolix/torrent?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
   4
   5 [![Codeship](https://www.codeship.io/projects/a2811d30-b0ce-0132-8983-5e604f7ebe37/status)](https://codeship.com/projects/69674)
   6 [![GoDoc](https://godoc.org/github.com/anacrolix/torrent?status.svg)](https://godoc.org/github.com/anacrolix/torrent)
   7
   8 This repository implements BitTorrent-related packages and command-line utilities in Go.
   9
  10 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.
  11
  12 ## Installation
  13
  14 Install the library package with `go get github.com/anacrolix/torrent`, or the provided cmds with `go get github.com/anacrolix/torrent/cmd/...`.
  15
  16 ## Library example
  17
  18 There is a small example in the [package documentation](https://godoc.org/github.com/anacrolix/torrent).
  19
  20 ## Torrent utility
  21
  22 There's a provided utility that downloads torrents from the command-line.
  23
  24         $ go get github.com/anacrolix/torrent/cmd/torrent
  25         $ torrent 'magnet:?xt=urn:btih:ZOCMZQIPFFW7OLLMIC5HUB6BPCSDEOQU'
  26     2015/03/20 22:51:41 main.go:96: downloaded ALL the torrents
  27     $ md5sum ubuntu-14.04.1-desktop-amd64.iso
  28     119cb63b48c9a18f31f417f09655efbd  ubuntu-14.04.1-desktop-amd64.iso
  29     $ echo such amaze
  30     wow