README.md
1# Package github.com/ooni/probe-engine/oonimkall
2
3Package oonimkall implements APIs used by OONI mobile apps. We
4expose these APIs to mobile apps using gomobile.
5
6We expose two APIs: the task API, which is derived from the
7API originally exposed by Measurement Kit, and the session API,
8which is a Go API that mobile apps can use via `gomobile`.
9
10This package is named oonimkall because it contains a partial
11reimplementation of the mkall API implemented by Measurement Kit
12in, e.g., [mkall-ios](https://github.com/measurement-kit/mkall-ios).
13
14The basic tenet of the task API is that you define an experiment
15task you wanna run using a JSON, then you start a task for it, and
16you receive events as serialized JSONs. In addition to this
17functionality, we also include extra APIs used by OONI mobile.
18
19The basic tenet of the session API is that you create an instance
20of `Session` and use it to perform the operations you need.
21