hg site extension
 
(Arne Babenhauserheide)
2011-10-20: Readme: added explicit usage info with example.

Readme: added explicit usage info with example.

diff --git a/README.txt b/README.txt
--- a/README.txt
+++ b/README.txt
@@ -17,6 +17,27 @@ Install:
 
 Usage:
 
-* hg site --help
+$ hg site -n <sitename> -u user:password@ftp.host.tld/path/to/dir
+→ that’s how this site gets created.
+
+$ hg site --help
+hg site [options] [folder]
+
+Create a static copy of the repository and/or upload it to an FTP server.
+
+use "hg help -e site" to show help for the site extension
+
+options:
+
+ -n --name VALUE         the repo name. Default: folder or last segment of the
+                         repo-path.
+ -u --upload VALUE       upload the repo to the given ftp host. Format:
+                         user:password@host/path/to/dir
+ -f --force              force recreating all commit files. Slow.
+ -s --screenstyle VALUE  use a custom stylesheet for display on screen
+ -p --printstyle VALUE   use a custom stylesheet for printing
+    --mq                 operate on patch repository
+
+use "hg -v help site" to show global options
 
 Related: git2html → http://hssl.cs.jhu.edu/~neal/git2html/