.. Microurl documentation master file, created by
   sphinx-quickstart on Mon Apr  4 11:26:43 2016.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to Microurl's documentation!
====================================

python library for url minification.

Features
--------
- Google
    - URL Minifier
    - QR Generator
- Bitly
    - URL Minifier


Installation
------------

Install microurl via `pip <http://www.pip-installer.org/>`_

.. code-block:: bash

    $ pip install microurl

Or, if you want the code that is currently on GitHub

.. code-block:: bash

    git clone git://github.com/micropyramid/microurl.git
    cd microurl
    python setup.py install

Contents:

.. toctree::
   :maxdepth: 2

   googleminifier
   bitlyminifier


Indices and tables
==================

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