ooni-probe-cli/internal/libminiooni/README.md
Simone Basso 6351d898d6
refactor: miniooni should be outside of the engine (#206)
* refactor: miniooni should be outside of the engine

This is part of https://github.com/ooni/probe/issues/1335. We also need
to think whether we wanna keep libminiooni and miniooni separated.

The previous use case for having a top-level libminiooni was that of
enabling others to integrate miniooni into other binaries.

This was usegul when studying internet censorship in Spain in May 2020.

I am wondering whether we should be keeping this complexity. I am not
sure about this and probably we should be killing it.

(In any case, reducing complexity is not the objective of this diff,
since I would like instead to move things around with minimal changes
and make sure we have a ~good repository organization here.)

* fix: import in libminiooni
2021-02-03 11:21:10 +01:00

15 lines
679 B
Markdown

# Package github.com/ooni/probe-engine/libminiooni
Package libminiooni implements the cmd/miniooni CLI. Miniooni is our
experimental client used for research and QA testing.
This CLI has CLI options that do not conflict with Measurement Kit
v0.10.x CLI options. There are some options conflict with the legacy
OONI Probe CLI options. Perfect backwards compatibility is not a
design goal for miniooni. Rather, we aim to have as little conflict
as possible such that we can run side by side QA checks.
We extracted this package from cmd/miniooni to allow us to further
integrate the miniooni CLI into other binaries (see for example the
code at github.com/bassosimone/aladdin).