We now have semi-working commit support! woo!

[mw] / README

diff --git a/README b/README
index c77b07a3c18f48a1f8d0c407077fa593a5bc839f..71dddb8376525b77cac4b23100bec456471e72e5 100644 (file)
--- a/README
+++ b/README
@@ -1,10 +1,18 @@
 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 ==
+See HACKING on how to run this; a nice setup.py isn't done yet.
 
+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
+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
@@ -16,5 +24,4 @@ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.
 
 You should have received a copy of the GNU General Public License along
-with this program; if not, write to the Free Software Foundation, Inc.,
-51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+with this program.  If not, see <http://www.gnu.org/licenses/>.