Add planned basic workflow to README
authorIan Weller <ian@ianweller.org>
Tue, 22 Dec 2009 08:50:13 +0000 (02:50 -0600)
committerIan Weller <ian@ianweller.org>
Tue, 22 Dec 2009 08:50:13 +0000 (02:50 -0600)
README

diff --git a/README b/README
index df2a37e3ceb6715ea2e2f6dc7ddf1dc67216b44f..edf84055026caf399dd9d4f82b603bd629f7ed20 100644 (file)
--- a/README
+++ b/README
@@ -1,10 +1,15 @@
 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 ==
+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?