Skip to content

Added example usage and fixed broken links #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
uber1geek wants to merge 4 commits into
base: master
Choose a base branch
from
+11 −1
Open

Added example usage and fixed broken links #11

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8aeafff
Added example useage and fixed broken links
Jan 31, 2018
9a5e327
Added example useage and fixed broken links
Jan 31, 2018
681d155
Added example useage and fixed broken links
Jan 31, 2018
dd88159
Added example useage and fixed broken links
Jan 31, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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