Append to PYTHONPATH, don't replace

[mw] / README

diff --git a/README b/README
index df2a37e3ceb6715ea2e2f6dc7ddf1dc67216b44f..54086211121d15b69db98d44d7c649a9426a1bad 100644 (file)
--- a/README
+++ b/README
@@ -1,10 +1,20 @@
 mw - VCS-like nonsense for MediaWiki websites
-Copyright (C) 2009  Ian Weller <ian@ianweller.org>
+Copyright (C) 2010  Ian Weller <ian@ianweller.org>
 
-For now, see HACKING for how to run this. This is far from complete and
-we're hoping to have awesome features soon. If you would like to help
-out, patches are greatly welcomed.
+== 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.
 
+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
+
+== 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