Explorar o código

USAGE.md for MeasurementLibrary

Miro Kuratczyk %!s(int64=7) %!d(string=hai) anos
pai
achega
d757201df3
Modificáronse 2 ficheiros con 21 adicións e 0 borrados
  1. 5 0
      MeasurementLibrary/README.md
  2. 16 0
      MeasurementLibrary/USAGE.md

+ 5 - 0
MeasurementLibrary/README.md

@@ -5,3 +5,8 @@ Overview
 --------------------------------------------------------------------------------
 --------------------------------------------------------------------------------
 
 
 The Psiphon Measurement Library is specifically intended for use by network measurement tools, such as [OONI](https://ooni.io/), and is not intended for general use and distribution.
 The Psiphon Measurement Library is specifically intended for use by network measurement tools, such as [OONI](https://ooni.io/), and is not intended for general use and distribution.
+
+Usage
+--------------------------------------------------------------------------------
+
+If you are using the Library in your app, please read the [USAGE.md](USAGE.md) instructions.

+ 16 - 0
MeasurementLibrary/USAGE.md

@@ -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.