Metadata-Version: 2.4
Name: readme
Version: 0.7.1
Summary: readme is a library for rendering "readme" descriptions for Warehouse
Home-page: https://github.com/pypa/readme
Author: Donald Stufft
Author-email: donald@stufft.io
License: Apache License, Version 2.0
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Natural Language :: English
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: POSIX
Classifier: Operating System :: POSIX :: BSD
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
License-File: LICENSE
Requires-Dist: readme_renderer
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: home-page
Dynamic: license
Dynamic: license-file
Dynamic: requires-dist
Dynamic: summary

readme
======

.. warning::

    The readme library was renamed to readme_renderer to work around an
    installation issue that could prevent it from being installed on
    some systems. Use the readme_renderer_ library instead.

Readme is a library that will safely render arbitrary README files into HTML.
It is designed to be used in Warehouse_ to render the ``long_description`` for packages.

.. _Warehouse: https://github.com/pypa/warehouse
.. _readme_renderer: https://pypi.python.org/pypi/readme_renderer

Check Description Locally
-------------------------

To check your long description's locally simply install the readme library
using:

.. code-block:: console

    $ pip install readme
    $ python setup.py check -r -s
