[tor-commits] [goptlib/master] Okay you can use it now.

[dcf at torproject.org]

commit 26b49b0f67e20de7f1be2764708908c6adab3ac3
Author: David Fifield <david at bamsoftware.com>
Date:   Sat Feb 8 16:07:59 2014 -0800

    Okay you can use it now.
---
 README |   22 +++++++++++++++++++++-
 1 file changed, 21 insertions(+), 1 deletion(-)

diff --git a/README b/README
index c791961..f3ce5b3 100644
--- a/README
+++ b/README
@@ -1,4 +1,24 @@
-This is alpha software. Don't use it.
+goptlib is a library for writing Tor pluggable transports in Go.
+
+https://gitweb.torproject.org/torspec.git/blob/HEAD:/pt-spec.txt
+https://gitweb.torproject.org/torspec.git/blob/HEAD:/proposals/196-transport-control-ports.txt
+https://gitweb.torproject.org/torspec.git/blob/HEAD:/proposals/217-ext-orport-auth.txt
+
+To download a copy of the library into $GOPATH:
+	go get git.torproject.org/pluggable-transports/goptlib.git
+
+See the included example programs for examples of how to use the
+library. To build them, enter their directory and run "go build".
+	examples/dummy-client/dummy-client.go
+	examples/dummy-server/dummy-server.go
+The recommended way to start writing a new transport plugin is to copy
+dummy-client or dummy-server and make changes to it.
+
+There is browseable documentation here:
+http://godoc.org/git.torproject.org/pluggable-transports/goptlib.git
+
+Report bugs to the tor-dev at lists.torproject.org mailing list or to the
+bug tracker at https://trac.torproject.org/projects/tor.
 
 To the extent possible under law, the authors have dedicated all
 copyright and related and neighboring rights to this software to the