X-Git-Url: https://wannabe.guru.org/gitweb/?a=blobdiff_plain;f=README.md;h=5102c54d7099fac7228cd57aa2f9147cd135e5df;hb=cd367f2063f3a58ab58d8a61a3ff6edd9ecbc8e5;hp=9f7cac9d3dbe41f6ec8a71851e29abda9d70d30a;hpb=69566c003b4f1c3a4905f37d3735d7921502d14a;p=pyutils.git

diff --git a/README.md b/README.md
index 9f7cac9..5102c54 100644
--- a/README.md
+++ b/README.md
@@ -1,30 +1,42 @@
 # pyutils
 
-This is a collection of Python utilities that I wrote and find useful.
-From collections that try to emulate Pythonic patterns
-(pyutils.collectionz) to a "smart" natural language date parser
-(pyutils.datetimez.dateparse_utils), to filesystem helpers
-(pyutils.files.file_utils) to a "simple" parallelization framework
-(pyutils.parallelize.parallelize).  I hope you find them useful.
+When I was writing little tools in Python and found myself implementing
+a generally useful pattern I stuffed it into a local library.  That
+library grew into pyutils: a set of collections, helpers and utilities
+that I find useful and hope you will too.
 
-Code is under src/*.  Most code includes doctests.
+Code is under [src/pyutils/](https://wannabe.guru.org/gitweb/?p=pyutils.git;a=tree;f=src/pyutils;h=e716e14b7a895e5c6206af90f4628bf756f040fe;hb=HEAD)
+Most code includes inlint documentation and doctests.  I've tried to
+organize it into logical packages based on the code's functionality.
+Note that when words would collide with a Python library or reserved
+word I've used a 'z' at the end, e.g. 'collectionz' instead of
+'collections', 'typez' instead of 'type', etc...
 
-Tests are under tests/*.  To run all tests:
+There's some example code that uses various features of this project checked
+in under [examples/](https://wannabe.guru.org/gitweb/?p=pyutils.git;a=tree;f=examples;h=d9744bf2b171ba7a9ff21ae1d3862b673647fff4;hb=HEAD) that you can check out.
+
+Unit and integration tests are under [tests/](
+https://wannabe.guru.org/gitweb/?p=pyutils.git;a=tree;f=tests;h=8c303f23cd89b6d2e4fbf214a5c7dcc0941151b4;hb=HEAD).  To run all tests:
 
     cd tests/
     ./run_tests.py --all [--coverage]
 
-See the README under tests/ for more options / information.
+See the [README](https://wannabe.guru.org/gitweb/?p=pyutils.git;a=blob_plain;f=tests/README;hb=HEAD)) under `tests/` and the code of `run_tests.py` for more options / information about running tests.
 
-This package generates Sphinx docs which are available at:
+This package generates Sphinx docs which are available at [https://wannabe.guru.org/pydocs/pyutils/pyutils.html](https://wannabe.guru.org/pydocs/pyutils/pyutils.html)
 
-    https://wannabe.guru.org/pydocs/pyutils/pyutils.html
+Package code is checked into a local git server and available to clone
+from git at https://wannabe.guru.org/git/pyutils.git or to view in a
+web browser at [https://wannabe.guru.org/gitweb/?p=pyutils.git;a=summary](https://wannabe.guru.org/gitweb/?p=pyutils.git;a=summary)
 
-For a long time this was just a local library on my machine that
-my tools imported but I've decided to release it on PyPi.  I hope
-you find it useful.  LICENSE and NOTICE describe reusing it and
-where everything came from.  Drop me a line if you are using this,
-find a bug, or have a question.
+For a long time this was just a local library on my machine that my
+tools imported but I've now decided to release it on PyPi.  Earlier
+development happened in a different git repo [https://wannabe.guru.org/gitweb/?p=python_utils.git;a=summary](https://wannabe.guru.org/gitweb/?p=python_utils.git;a=summary)
 
-  --Scott Gasch (scott.gasch@gmail.com)
+The [LICENSE](https://wannabe.guru.org/gitweb/?p=pyutils.git;a=blob_plain;f=LICENSE;hb=HEAD)
+and [NOTICE](https://wannabe.guru.org/gitweb/?p=pyutils.git;a=blob_plain;f=NOTICE;hb=HEAD)
+files at the root of the project describe reusing this code and where
+everything came from.  Drop me a line if you are using this, find a
+bug, have a question, or have a suggestion:
 
+  --Scott Gasch (scott.gasch@gmail.com)