|
|
@@ -0,0 +1,16 @@
|
|
|
+# Using the Psiphon Measurement Library
|
|
|
+
|
|
|
+## Overview
|
|
|
+
|
|
|
+The Psiphon Measurement Library enables you to easily embed a test of Psiphon in your app.
|
|
|
+
|
|
|
+## Using the Psiphon network
|
|
|
+
|
|
|
+In order to use the Psiphon Measurement Library for testing the Psiphon network, you need to contact Psiphon to obtain connection parameters to use with your application. Please email us at [info@psiphon.ca](mailto: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 measurement library.
|
|
|
+
|
|
|
+**Second step:** Review the comments in [`PsiphonTunnel.h`](example/PsiphonTunnel.h). They describe the testing interface.
|