From 6fa53928d9818f92117b6d10bf2c080bec608a3f Mon Sep 17 00:00:00 2001 From: reagle Date: Fri, 4 Feb 2011 16:38:05 -0500 Subject: [PATCH] some documentation on commands --- README | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/README b/README index 6c50091..a7224e5 100644 --- a/README +++ b/README @@ -10,9 +10,22 @@ 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 status + +== Status command == + +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 == This program is free software; you can redistribute it and/or modify -- 2.39.5