From 0df5385bebfd37693f6edd65707871b7daa87497 Mon Sep 17 00:00:00 2001 From: Kenneth Reitz Date: Sun, 16 May 2010 15:50:15 -0400 Subject: [PATCH] Documentation upate --- README.rst | 27 ++++++++++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 9eb3084..307bbcb 100644 --- a/README.rst +++ b/README.rst @@ -5,6 +5,30 @@ This is a Python wrapper for GitHub's Gist API. http://develop.github.com/p/gist.html +Example Usage +------------- + from gistapi import * + + >> Gist('d4507e882a07ac6f9f92').repo + 'd4507e882a07ac6f9f92' + + >> Gist('d4507e882a07ac6f9f92').description + 'Example Gist for gist.py' + + >> Gist('d4507e882a07ac6f9f92').created_at + '2010/05/16 10:51:15 -0700' + + >> Gist('d4507e882a07ac6f9f92').public + False + + >> Gist('d4507e882a07ac6f9f92').filenames + ['exampleEmptyFile', 'exampleFile'] + + >> Gist('d4507e882a07ac6f9f92').files + {'exampleFile': 'Example file content.', 'exampleEmptyFile': ''} + + >> Gists.fetch_by_user('kennethreitz')[-1].description + 'My .bashrc configuration' Roadmap ------- @@ -17,4 +41,5 @@ Roadmap - Delete a Gist - Edit a Gist * Possibly use other hacks in the meantime -* Possibly add command line gist interface \ No newline at end of file +* Possibly add command line gist interface +