psiphon-tunnel-core/ClientLibrary/USAGE.md

Using the Psiphon Client Library

Overview

The Psiphon Client Library enables you to easily embed Psiphon in your app.

Using the Psiphon network

In order to use the Psiphon Client Library over the Psiphon network, you need to contact Psiphon to obtain connection parameters to use with your application. Please email us at info@psiphon.ca.

Using the Library in your App

First step: Review the sample code, located under example. This code provides an example of how to correctly use the client library.

Second step: Review the comments for Start and Stop in PsiphonTunnel.go. They describe the client interface.