diff --git a/README.rst b/README.rst index 41fa9d9..fbebdd4 100644 --- a/README.rst +++ b/README.rst @@ -4,6 +4,7 @@ Clint: Python Command-line Application Helpers [Image of Clint Eastwood] Features: +--------- - CLI Colors and Indents - Iterator-based Progress Bar @@ -12,13 +13,67 @@ Features: - Application Directory management -**``clint.textui``** +``clint.textui`` -**``clint.resources``** +``clint.resources`` -**``clint.piped_in()``** +``clint.piped_in()`` -**``clint.args``** +``clint.args`` + + + +Installation +------------ + +To install clint, simply: :: + + $ pip install clint + +Or, if you absolutely must: :: + + $ easy_install clint + +But, you really shouldn't do that. + + + +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. Make +sure you add yourself to AUTHORS_. + + +Roadmap +------- +- Unittests +- Sphinx Documentation +- Python 2.5, 3.1, 3.2 Support + + +.. _`the repository`: http://github.com/kennethreitz/clint +.. _AUTHORS: http://github.com/kennethreitz/clint/blob/master/AUTHORS