]> projects.mako.cc - mw/blobdiff - README
PEP 8 and code cleanup
[mw] / README
diff --git a/README b/README
index df2a37e3ceb6715ea2e2f6dc7ddf1dc67216b44f..d1f1582cdd46ee0686f3d244b23a4e2ed6ed4d5f 100644 (file)
--- a/README
+++ b/README
@@ -1,10 +1,17 @@
 mw - VCS-like nonsense for MediaWiki websites
 Copyright (C) 2009  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 ==
+See HACKING on how to run this; a nice setup.py isn't done yet.
 
+mw init http://path.to/api.php
+mw pull 'Main Page'
+$EDITOR Main_Page.wiki
+mw fetch # check for newer revisions
+mw update # apply newer revisions
+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

Benjamin Mako Hill || Want to submit a patch?