From: Matt Joiner <anacrolix@gmail.com>
Date: Wed, 1 Apr 2015 03:36:38 +0000 (+1100)
Subject: Update README
X-Git-Tag: v1.0.0~1217
X-Git-Url: http://www.git.stargrave.org/?a=commitdiff_plain;h=6d9e800a1e331c982c6e1a7e088c39d5d1501c09;p=btrtrc.git

Update README
---

diff --git a/README.md b/README.md
index 48276806..47b6d280 100644
--- a/README.md
+++ b/README.md
@@ -7,6 +7,8 @@ This repository implements BitTorrent-related packages and command-line utilitie
 
 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.
 
+See also the [mailing list](https://groups.google.com/forum/#!forum/go_torrent), and the [Gophers Slack channel](https://gophers.slack.com/#torrent).
+
 ## Installation
 
 Install the library package with `go get github.com/anacrolix/torrent`, or the provided cmds with `go get github.com/anacrolix/torrent/cmd/...`.
@@ -15,14 +17,42 @@ Install the library package with `go get github.com/anacrolix/torrent`, or the p
 
 There is a small example in the [package documentation](https://godoc.org/github.com/anacrolix/torrent).
 
-## Torrent utility
+## Commands
+
+Here I'll describe what some of the provided commands in `./cmd` do.
+
+Note that [`godo`](https://bitbucket.org/anacrolix/go-utils) that I invoke in the following examples is a command that builds and executes a Go import path, like `go run`. It's easier to use this convention than to spell out the install/invoke cycle for every single example.
 
-There's a provided utility that downloads torrents from the command-line.
+### torrent
+
+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
+	$ torrent 'magnet:?xt=urn:btih:KRWPCX3SJUM4IMM4YF5RPHL6ANPYTQPU'
+    2015/04/01 02:08:20 main.go:137: downloaded ALL the torrents
+    $ md5sum ubuntu-14.04.2-desktop-amd64.iso
+    1b305d585b1918f297164add46784116  ubuntu-14.04.2-desktop-amd64.iso
     $ echo such amaze
     wow
+
+### torrentfs
+
+torrentfs mounts a FUSE filesystem at `-mountDir`. The contents are the torrents described by the torrent files and magnet links at `-torrentPath`. Data for read requests is fetched only as required from the torrent network, and stored at `-downloadDir`.
+
+    $ mkdir mnt torrents
+    $ godo github.com/anacrolix/torrent/cmd/torrentfs -mountDir mnt -torrentPath torrents &
+    $ cd torrents
+    $ wget http://releases.ubuntu.com/14.04.2/ubuntu-14.04.2-desktop-amd64.iso.torrent
+    $ cd ..
+    $ ls mnt
+    ubuntu-14.04.2-desktop-amd64.iso
+    $ pv mnt/ubuntu-14.04.2-desktop-amd64.iso | md5sum
+    996MB 0:04:40 [3.55MB/s] [========================================>] 100%
+    1b305d585b1918f297164add46784116  -
+
+### torrent-magnet
+
+Creates a magnet link from a torrent file. Note the extracted trackers, display name, and info hash.
+
+    $ godo github.com/anacrolix/torrent/cmd/torrent-magnet < ubuntu-14.04.2-desktop-amd64.iso.torrent
+	magnet:?xt=urn:btih:546cf15f724d19c4319cc17b179d7e035f89c1f4&dn=ubuntu-14.04.2-desktop-amd64.iso&tr=http%3A%2F%2Ftorrent.ubuntu.com%3A6969%2Fannounce&tr=http%3A%2F%2Fipv6.torrent.ubuntu.com%3A6969%2Fannounce
\ No newline at end of file