Skip to content

Commit

Permalink
Move to .rst readme.
Browse files Browse the repository at this point in the history
Conflicts:
	README.md
  • Loading branch information
malicustommade committed Aug 19, 2013
1 parent 33de285 commit e914082
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 12 deletions.
11 changes: 0 additions & 11 deletions README.md

This file was deleted.

15 changes: 15 additions & 0 deletions README.rst
@@ -0,0 +1,15 @@
===========
simpleflake
===========

Distributed ID generation in python for the lazy. To install, run::

pip install simpleflake

You can read an overview of what this does and why it came into being at the `Sawdust Software Blog`_.

You can also read the `API Documentation`_ and check out the `Travis build status`_.

.. _Sawdust Software Blog: http://engineering.custommade.com/simpleflake-distributed-id-generation-for-the-lazy
.. _API Documentation: https://simpleflake.readthedocs.org/en/latest/
.. _Travis build status: https://travis-ci.org/SawdustSoftware/simpleflake
2 changes: 1 addition & 1 deletion setup.py
@@ -1,6 +1,6 @@
from distutils.core import setup

with open('README.txt') as file:
with open('README.rst') as file:
long_description = file.read()

setup(
Expand Down

0 comments on commit e914082

Please sign in to comment.