[Checkins] SVN: z3c.checkversions/trunk/ updated the doc and renamed the changelog

[Christophe Combelles]

Log message for revision 112432:
  updated the doc and renamed the changelog
  

Changed:
  A   z3c.checkversions/trunk/CHANGELOG.txt
  D   z3c.checkversions/trunk/HISTORY.txt
  U   z3c.checkversions/trunk/README.txt
  U   z3c.checkversions/trunk/setup.py

-=-
Copied: z3c.checkversions/trunk/CHANGELOG.txt (from rev 112431, z3c.checkversions/trunk/HISTORY.txt)
===================================================================
--- z3c.checkversions/trunk/CHANGELOG.txt	                        (rev 0)
+++ z3c.checkversions/trunk/CHANGELOG.txt	2010-05-17 21:32:33 UTC (rev 112432)
@@ -0,0 +1,13 @@
+Changelog
+=========
+
+0.2 (unreleased)
+----------------
+
+- added a verbose option to print old versions as well
+- updated metadata, doc and license
+
+0.1 (2010-05-16)
+----------------
+
+- Initial release

Deleted: z3c.checkversions/trunk/HISTORY.txt
===================================================================
--- z3c.checkversions/trunk/HISTORY.txt	2010-05-17 21:04:55 UTC (rev 112431)
+++ z3c.checkversions/trunk/HISTORY.txt	2010-05-17 21:32:33 UTC (rev 112432)
@@ -1,13 +0,0 @@
-Changelog
-=========
-
-0.2 (unreleased)
-----------------
-
-- added a verbose option to print old versions as well
-- updated metadata, doc and license
-
-0.1 (2010-05-16)
-----------------
-
-- Initial release

Modified: z3c.checkversions/trunk/README.txt
===================================================================
--- z3c.checkversions/trunk/README.txt	2010-05-17 21:04:55 UTC (rev 112431)
+++ z3c.checkversions/trunk/README.txt	2010-05-17 21:32:33 UTC (rev 112432)
@@ -29,53 +29,60 @@
     recipe=zc.recipe.egg
     eggs=z3c.checkversions
 
+
 Usage
 =====
 
-For installed packages
-----------------------
+::
 
-Imagine `foobar` 1.0.1 is installed in your system
+    $ checkversions -h
+    Usage: checkversions [options]
+    
+    This script will check new package versions of either your current installed
+    distributions or a buildout file if provided. It can detect major or minor
+    versions availability: level 0 gets the highest version (X.y.z), level 1 gets
+    the highest intermediate version (x.Y.z), level 2 gets the highest minor
+    version (x.y.Z).  Using level 2, you can automatically retrieve all bugfix
+    versions of a buildout.
+    
+    Options:
+      -h, --help            show this help message and exit
+      -l LEVEL, --level=LEVEL
+                            Version level to check
+      -i INDEX, --index=INDEX
+                            Alternative package index URL
+      -v, --verbose         Verbose mode (prints old versions too)
 
-Check the highest versions available::
 
-    $ checkversions
-    foobar=2.3.5
+Examples
+========
 
-Check the highest intermediate upgrades available::
+For installed packages
+----------------------
 
-    $ checkversions -l 1
-    foobar=1.4.2
+Example with a virtualenv::
 
-Check the highest minor upgrades available::
+    $ virtualenv --no-site-packages sandbox
+    $ sandbox/bin/pip install z3c.checkversions
+    $ sandbox/bin/checkversions -v -l 1
+    # Checking your installed distributions
+    pip=0.7.1 # was: 0.6.3
 
-    $ checkversions -l 2
-    foobar=1.0.5
-
 For a buildout
 --------------
 
-The usage is the same, you just have to specify the buildout file to scan.
-The buildout does not need to be built.
+It can work either with a full buildout.cfg or with a simple versions.cfg file.
 
-Imagine you have a buildout.cfg with::
+Here is a sample `versions.cfg` file::
 
     [versions]
-    foobar=1.0.0
+    pip=0.6.3
 
-Check the highest versions available::
+You can create a new versions.cfg with the output ::
 
-    $ checkversions buildout.cfg
-    foobar=2.3.5
+    $ checkversions -v -l 1 versions.cfg
+    # Checking your installed distributions
+    pip=0.7.1 # was: 0.6.3
 
-Check the highest intermediate upgrades available::
 
-    $ checkversions -l 1 buildout.cfg
-    foobar=1.4.2
 
-Check the highest minor upgrades available::
-
-    $ checkversions -l 2 buildout.cfg
-    foobar=1.0.5
-
-

Modified: z3c.checkversions/trunk/setup.py
===================================================================
--- z3c.checkversions/trunk/setup.py	2010-05-17 21:04:55 UTC (rev 112431)
+++ z3c.checkversions/trunk/setup.py	2010-05-17 21:32:33 UTC (rev 112432)
@@ -21,7 +21,7 @@
       version=version,
       description="Find newer package versions on PyPI",
       long_description=open("README.txt").read() + "\n" +
-                       open("HISTORY.txt").read(),
+                       open("CHANGELOG.txt").read(),
       # Get more strings from http://pypi.python.org/pypi?%3Aaction=list_classifiers
       classifiers=[
        "Programming Language :: Python",