zeroconf: add extension documentation
authorDavid Soria Parra <dsp@php.net>
Mon, 05 Jan 2009 20:49:12 +0100
changeset 7606 e86ca711544d
parent 7605 3e592067515d
child 7607 3cf85220a9f9
zeroconf: add extension documentation
hgext/zeroconf/__init__.py
--- a/hgext/zeroconf/__init__.py	Mon Jan 05 12:48:20 2009 -0500
+++ b/hgext/zeroconf/__init__.py	Mon Jan 05 20:49:12 2009 +0100
@@ -6,6 +6,29 @@
 # the GNU General Public License (version 2), incorporated herein by
 # reference.
 
+'''zeroconf support for mercurial repositories
+
+Zeroconf enabled repositories will be announced in a network without the need
+to configure a server or a service. They can be discovered without knowing
+their actual IP address.
+
+To use the zeroconf extension add the following entry to your hgrc file:
+
+[extensions]
+hgext.zeroconf =
+
+To allow other people to discover your repository using run "hg serve" in your
+repository.
+
+ $ cd test
+ $ hg serve
+
+You can discover zeroconf enabled repositories by running "hg paths".
+
+ $ hg paths
+ zc-test = http://example.com:8000/test
+'''
+
 import Zeroconf, socket, time, os
 from mercurial import ui
 from mercurial import extensions