diff --git a/README.rst b/README.rst index 7b4d682..0a92405 100644 --- a/README.rst +++ b/README.rst @@ -3,5 +3,13 @@ BeanBag ======= BeanBag is a simple module that lets you access REST APIs in an easy -way. See `http://beanbag.readthedocs.org/` for more information. +way. For example: + + >>> import beanbag + >>> github = beanbag.BeanBag("https://api.github.com") + >>> watchers = github.repos.ajtowns.beanbag.watchers() + >>> for w in watchers: + ... print(w["login"]) + +See `http://beanbag.readthedocs.org/` for more information.