From: nsf <no.smile.face@gmail.com>
Date: Thu, 5 Jul 2012 16:47:14 +0000 (+0600)
Subject: Add Builder docs. A bit shallow for now, but whatever.
X-Git-Tag: v1.0.0~1199^2~21
X-Git-Url: http://www.git.stargrave.org/?a=commitdiff_plain;h=d684312a802caf5040626fadf488978e06cbed4a;p=btrtrc.git

Add Builder docs. A bit shallow for now, but whatever.
---

diff --git a/torrent/builder.go b/torrent/builder.go
index 95ed8816..6dd6eb6b 100644
--- a/torrent/builder.go
+++ b/torrent/builder.go
@@ -12,6 +12,9 @@ import (
 	"os"
 )
 
+// The Builder type is responsible for .torrent files construction. Just
+// instantiate it, call necessary methods and then call the .Build method. While
+// waiting for completion you can use 'status' channel to get status reports.
 type Builder struct {
 	filesmap      map[string]bool
 	files         []file