# HG changeset patch
# User Steve Losh <steve@stevelosh.com>
# Date 1276646432 14400
# Node ID c549ca1eeb815838475091838617927dc601655b
# Parent  30864e67432fcfed028db50c0b47beeb242667e6
docs: work on the webui docs

diff -r 30864e67432f -r c549ca1eeb81 docs/concepts.rst
--- a/docs/concepts.rst	Tue Jun 15 19:23:15 2010 -0400
+++ b/docs/concepts.rst	Tue Jun 15 20:00:32 2010 -0400
@@ -112,7 +112,7 @@
 
     This changeset doesn't really impact me, so I don't care.
 
-or:
+or perhaps:
 
     I've looked at this code but don't have the expertise to provide a useful
     opinion.
diff -r 30864e67432f -r c549ca1eeb81 docs/index.rst
--- a/docs/index.rst	Tue Jun 15 19:23:15 2010 -0400
+++ b/docs/index.rst	Tue Jun 15 20:00:32 2010 -0400
@@ -66,4 +66,5 @@
 
    dev
    hacking
+   licensing
 
diff -r 30864e67432f -r c549ca1eeb81 docs/licensing.rst
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/licensing.rst	Tue Jun 15 20:00:32 2010 -0400
@@ -0,0 +1,3 @@
+Licensing
+=========
+
diff -r 30864e67432f -r c549ca1eeb81 docs/webui.rst
--- a/docs/webui.rst	Tue Jun 15 19:23:15 2010 -0400
+++ b/docs/webui.rst	Tue Jun 15 20:00:32 2010 -0400
@@ -1,11 +1,57 @@
 Web Interface
 =============
 
-
 The web interface of hg-review is probably what you're going to use the most.
 
-Local Use
----------
+Running Locally
+---------------
+
+To start the web interface for a local repository that you want to review you
+can run ``hg review --web``. Visit http://localhost:8080/ to use it.
+
+When you add comments or signoffs hg-review will use your normal Mercurial
+username as the author.
+
+This command can take a few extra options:
+
+``--address ADDRESS``
+    The address to bind to. Use ``0.0.0.0`` if you want other people to be able
+    to access it.
+
+    **Be careful!** Because the web interface uses your Mercurial username by
+    default, binding to ``0.0.0.0`` will let anyone add comments and signoffs
+    in your name! You'll probably want to use the ``--read-only`` option to
+    prevent this.
+
+    Default: ``127.0.0.1``
+
+``--port PORT``
+    The port to listen on.
+
+    Default: ``8080``
+
+``--read-only``
+    Run the server in read-only mode. This will not allow data to be pushed or
+    pulled, comments to be made or signoffs to be added.
+
+    This can be useful when combined with ``--address`` to let other people
+    view the UI without letting them add comments in your name.
+
+    Default: ``false``
+
+``--allow-anon``
+    Allow comments (not not signoffs) to be added even if ``--read-only`` is
+    used, and set the username to ``Anonymous <anonymous@example.com>`` instead
+    of your Mercurial username.
+
+    This option is most useful when you're deploying a permanent web interface
+    to a server and want to allow anonymous viewers to add comments. See the
+    :ref:`deployment` section for more information.
+
+    Default: ``false``
+
+
+.. _deployment:
 
 Deployment to a Server
 ----------------------