diff --git a/README.rst b/README.rst index 41bf4b2..7430b14 100644 --- a/README.rst +++ b/README.rst @@ -6,10 +6,20 @@ Distributed ID generation in python for the lazy. To install, run:: pip install simpleflake +Example usage:: + + from simpleflake import simpleflake + + def getid(): + return 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 + +.. _Sawdust Software Blog: https://web.archive.org/web/20140420064035/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