README.rst

PrivateStorageio
================

The backend for a private, secure, and end-to-end encrypted storage solution.

Documentation
~~~~~~~~~~~~~

There is documentation for:

* Operators/Admins: `<docs/source/ops/README.rst>`_
* Developers: `<docs/source/dev/README.rst>`_

The documentation can be built using this command::

  $ nix-build docs.nix

The documentation is also built on and published by CI:
Navigate to the `list of finished jobs <https://whetstone.private.storage/privatestorage/PrivateStorageio/-/jobs>`_ and download the artefact of the latest ``docs`` build.