From b3c32180765d6c9093bee3b51ee57dba12e0a6a5 Mon Sep 17 00:00:00 2001 From: Hamza Faran Date: Sat, 1 Aug 2015 02:36:39 -0700 Subject: [PATCH] Comment on the inclusion of documentation --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 5750980..af877c7 100644 --- a/README.md +++ b/README.md @@ -35,5 +35,5 @@ python setup.py install ## Getting Started -* Documentation is coming soon, but in the meantime check out the [examples](https://github.com/hfaran/progressive/blob/master/progressive/examples.py). +* There is preliminary documentation is available at [readthedocs](http://progressive.readthedocs.org/) but more detailed documentation is coming soon on completion of the 1.0 API, but in the meantime check out the [examples](https://github.com/hfaran/progressive/blob/master/progressive/examples.py). * `progressive` supports graceful fallback modes for terminals without colors, [but you really should upgrade your terminal to 256 colors](http://pastelinux.wordpress.com/2010/12/01/upgrading-linux-terminal-to-256-colors/) to make full use of `progressive`.