Welcome to `dreadlocks`' documentation!
=======================================

:mod:`dreadlocks` is a cross-platform file-locking software library for  Python
that supports thread-level locks, process-level locks, and both simultaneously.

Check out the :doc:`usage` section for further information, including
how to :ref:`install<installation>` the project.

.. note::

   This is work in progress.

Contents
--------

.. toctree::

   usage
   api