diff --git a/README.md b/README.md index bced76e7136504ad9f1425b675ac99245ee5f18d..bb2e661a6bd2a2ffab5bbb1e2dd2b86c015e5677 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,12 @@ The easiest way to install Briar Wrapper is to install [the package from PyPi.org](https://pypi.org/project/briar_wrapper/): `pip install briar_wrapper` +## Documentation + +The documentation of the project can be found at +[wrapper.docs.briarproject.org](https://wrapper.docs.briarproject.org/). +To generate it locally, call `tools/generate-docs.sh`. + ## Building You can also build it yourself by runninng the following command: @@ -59,11 +65,6 @@ And install the .deb like this: sudo dpkg -i ../python3-briar-wrapper_0.0.3-1_all.deb ``` -## Documentation - -The documentation of the project's code can be found in the _docs_ directory. -To generate it, call `tools/generate-docs.sh`. - ## Design Goals * Main platform is GNU/Linux, but should also support (at least) Windows and macOS