Skip to content

Commit

Permalink
Move to restructured text README.
Browse files Browse the repository at this point in the history
This is compatible with PyPI.
  • Loading branch information
dopplershift committed May 15, 2015
1 parent ae461a5 commit 84403ce
Show file tree
Hide file tree
Showing 3 changed files with 79 additions and 10 deletions.
1 change: 1 addition & 0 deletions README
10 changes: 0 additions & 10 deletions README.md

This file was deleted.

78 changes: 78 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
Siphon
======

.. image:: https://pypip.in/status/siphon/badge.svg
:target: https://pypi.python.org/pypi/siphon/
:alt: Development Status

.. image:: https://pypip.in/py_versions/siphon/badge.svg
:target: https://pypi.python.org/pypi/siphon/
:alt: Supported Python versions

.. image:: https://pypip.in/implementation/siphon/badge.svg
:target: https://pypi.python.org/pypi/siphon/
:alt: Supported Python implementations

.. image:: https://pypip.in/license/siphon/badge.svg
:target: https://pypi.python.org/pypi/siphon/
:alt: License

.. image:: https://pypip.in/version/siphon/badge.svg?text=version
:target: https://pypi.python.org/pypi/siphon/
:alt: Latest Version

.. image:: https://pypip.in/format/siphon/badge.svg
:target: https://pypi.python.org/pypi/siphon/
:alt: Download format

.. image:: https://pypip.in/download/siphon/badge.svg?period=month
:target: https://pypi.python.org/pypi/siphon/
:alt: Downloads

.. image:: https://travis-ci.org/Unidata/siphon.svg?branch=master
:target: https://travis-ci.org/Unidata/siphon
:alt: Travis Build Status

.. image:: https://coveralls.io/repos/Unidata/siphon/badge.svg?branch=master
:target: https://coveralls.io/r/Unidata/siphon
:alt: Coveralls Coverage Status

.. image:: https://landscape.io/github/Unidata/siphon/master/landscape.svg?style=flat
:target: https://landscape.io/github/Unidata/siphon/master
:alt: Code Health

.. image:: https://readthedocs.org/projects/pip/badge/?version=latest
:target: http://siphon.readthedocs.org/en/latest/
:alt: Latest Doc Build Status

.. image:: https://readthedocs.org/projects/pip/badge/?version=stable
:target: http://siphon.readthedocs.org/en/stable/
:alt: Stable Doc Build Status

Siphon is a collection of Python utilities for downloading data from Unidata
data technologies.

Siphon is still in an early stage of development, and as such
**no APIs are considered stable.** While we won't break things
just for fun, many things may still change as we work through
design issues.

Installation
------------
::
git clone https://github.com/Unidata/siphon.git
cd siphon
python setup.py install

Important Links
---------------

- Source code repository: https://github.com/Unidata/siphon
- HTML Documentation (stable release): http://siphon.readthedocs.org/en/stable/
- HTML Documentation (development): http://siphon.readthedocs.org/en/latest/
- Issue tracker: http://github.com/Unidata/siphon/issues

Dependencies
------------

None

0 comments on commit 84403ce

Please sign in to comment.