==========================
everest User Documentation
==========================

:mod:`everest` is an extension of the popular :mod:`Pyramid` framework aimed at
simplifying the development of REST applications.

Installation
============

Installing :mod:`everest` is simple:

.. code-block:: console

   > pip install everest


Documentation
=============

:doc:`tutorial/index`
  Start here for a tutorial on building :mod:`everest` applications.

:doc:`api`
  The full API Documentation


Development
===========

:mod:`everest` is hosted on `github <https://github.com/cenix/everest>`_. To
contribute, please fork the project and submit a pull request.


.. toctree::
   :hidden:

   tutorial/index 
   api


Indices
=======

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`