..
    This file is part of Invenio.
    Copyright (C) 2015-2019 CERN.

    Invenio is free software; you can redistribute it and/or modify it
    under the terms of the MIT License; see LICENSE file for more details.


.. include:: ../README.rst

User's Guide
------------

At first **read the principles** section to find out if this library is usable for your use cases.

Do not skip steps in the configuration section - if you skip any of them your application
will be insecure.

As nobody is perfect, if you use this library **do your own security testing**
on your repository.

Enjoy!

.. toctree::
   :maxdepth: 2

   principles
   installation
   configuration
   usage
   implementation
   extending


API Reference
-------------

If you are looking for information on a specific function, class or method,
this part of the documentation is for you.

.. toctree::
   :maxdepth: 2

   api