From 514290c5e62a3c73a552509ab7b8d91747ee72ec Mon Sep 17 00:00:00 2001 From: Nico Alt <nicoalt@posteo.org> Date: Thu, 3 Sep 2020 12:55:49 +0200 Subject: [PATCH] Link to wrapper.docs.briarproject.org --- README.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index bced76e..bb2e661 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 -- GitLab