1goptlib is a library for writing Tor pluggable transports in Go.
2
3https://spec.torproject.org/pt-spec
4https://gitweb.torproject.org/torspec.git/tree/proposals/196-transport-control-ports.txt
5https://gitweb.torproject.org/torspec.git/tree/proposals/217-ext-orport-auth.txt
6https://gitweb.torproject.org/torspec.git/tree/proposals/232-pluggable-transports-through-proxy.txt
7
8To download a copy of the library into $GOPATH:
9	go get git.torproject.org/pluggable-transports/goptlib.git
10
11See the included example programs for examples of how to use the
12library. To build them, enter their directory and run "go build".
13	examples/dummy-client/dummy-client.go
14	examples/dummy-server/dummy-server.go
15The recommended way to start writing a new transport plugin is to copy
16dummy-client or dummy-server and make changes to it.
17
18There is browseable documentation here:
19https://godoc.org/git.torproject.org/pluggable-transports/goptlib.git
20
21Report bugs to the tor-dev@lists.torproject.org mailing list or to the
22bug tracker at https://trac.torproject.org/projects/tor.
23
24To the extent possible under law, the authors have dedicated all
25copyright and related and neighboring rights to this software to the
26public domain worldwide. This software is distributed without any
27warranty. See COPYING.
28