Merge branch 'upstream'

[mw] / README

diff --git a/README b/README
index 54086211121d15b69db98d44d7c649a9426a1bad..2cb0e8210c242dd9ce93e74faed6e69b1461d9c7 100644 (file)
--- a/README
+++ b/README
@@ -1,20 +1,50 @@
 mw - VCS-like nonsense for MediaWiki websites
 mw - VCS-like nonsense for MediaWiki websites

-Copyright (C) 2010  Ian Weller <ian@ianweller.org>
+Copyright (C) 2011  Ian Weller <ian@ianweller.org> and others
+
+== Setup ==

 
 

-== Basic workflow ==

 We don't have a nice installation process yet, so set the following alias:
   alias mw="PYTHONPATH=$PYTHONPATH:PATH_TO/mw/src PATH_TO/mw/bin/mw"
 where PATH_TO is the path to your local mw repository.
 
 We don't have a nice installation process yet, so set the following alias:
   alias mw="PYTHONPATH=$PYTHONPATH:PATH_TO/mw/src PATH_TO/mw/bin/mw"
 where PATH_TO is the path to your local mw repository.
 

+== Basic workflow ==
+

 mw init http://example.com/w/api.php
 mw login  # if you need/want to
 mw pull 'Main Page'
 $EDITOR Main_Page.wiki
 mw init http://example.com/w/api.php
 mw login  # if you need/want to
 mw pull 'Main Page'
 $EDITOR Main_Page.wiki

-mw fetch  # check for newer revisions; this command doesn't exist yet
-mw update  # apply newer revisions; this command doesn't exist yet

 mw commit
 mw commit

+mw status
+
+== Commands ==
+
+usage: mw [subcommand]
+
+        commit (ci)    commit changes to wiki   
+        diff           diff wiki to working directory
+        init           start a mw repo          
+        login          authenticate with wiki   
+        logout         forget authentication    
+        merge          run merge tool on conflicting locate/remove diffs
+        pull           add remote pages to repo 
+        pullcat        add remote pages to repo belonging to the given category
+        status (st)    check repo status     
+
+=== Status command ===
+
+`status` Will show whether a file has been locally modified ('M') or is clean ('C').
+
+=== Pull command ===
+
+The `pull` command has the following features:
+
+* Can pull a new page/file, or update one.
+* Can be provided a page name or file name.
+* If the wiki has updates, it will pull those unless they conflict 
+  with local changes. The user must then resolve/merge conflicts.

 
 == License ==
 
 == License ==

+

 This program is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
 the Free Software Foundation; either version 2 of the License, or
 This program is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
 the Free Software Foundation; either version 2 of the License, or