github.com/ooni/psiphon/tunnel-core@v0.0.0-20230105123940-fe12a24c96ee/oovendor/goptlib/README (about)

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