Publicly expose Torrent.GotInfo

[btrtrc.git] / doc.go

diff --git a/doc.go b/doc.go
new file mode 100644 (file)
index 0000000..f8670a9
--- /dev/null
+++ b/doc.go
@@ -0,0 +1,16 @@
+/*
+Package torrent implements a torrent client.
+
+Simple example:
+
+       c, _ := torrent.NewClient(&torrent.Config{})
+       defer c.Close()
+       t, _ := c.AddMagnet("magnet:?xt=urn:btih:ZOCMZQIPFFW7OLLMIC5HUB6BPCSDEOQU")
+       <-t.GotInfo
+       t.DownloadAll()
+       c.WaitAll()
+       log.Print("ermahgerd, torrent downloaded")
+
+
+*/
+package torrent