From 897ff8b0d749108a7976744f51fe4b88763d9ca5 Mon Sep 17 00:00:00 2001 From: Kenneth Reitz Date: Wed, 23 Mar 2011 08:58:52 -0400 Subject: [PATCH] thrown together readme --- README.rst | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 54 insertions(+) create mode 100644 README.rst diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..0a2c8f1 --- /dev/null +++ b/README.rst @@ -0,0 +1,54 @@ +Humble: GitHub User Stats +========================= + + + +Features: +--------- + +- Lists a user's repos. + + +Installation +------------ + +To install humble, simply: :: + + $ pip install humble + +Or, if you absolutely must: :: + + $ easy_install humble + +But, you really shouldn't do that. + + + +License: +-------- + +ISC License. :: + + Copyright (c) 2011, Kenneth Reitz + + Permission to use, copy, modify, and/or distribute this software for any + purpose with or without fee is hereby granted, provided that the above + copyright notice and this permission notice appear in all copies. + + THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES + WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF + MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR + ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES + WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN + ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF + OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. + + +Contribute +---------- + +If you'd like to contribute, simply fork `the repository`_, commit your changes +to the **develop** branch (or branch off of it), and send a pull request. + + +.. _`the repository`: http://github.com/kennethreitz/humble