Commits

Thomas Pelletier committed a65b507

add README.markdown and LICENCE

Comments (0)

Files changed (3)

+Copyright (c) 2010 Thomas Pelletier
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+Hg-publishall
+=============
+
+Hg-publishall is a [mercurial](http://mercurial.selenic.com/) extension which
+allows you to push simultaneously to multiple repositories, in a single
+command.
+
+Installation
+------------
+
+First, clone the repository, let's say in your home directory:
+
+    hg clone ssh://hg@bitbucket.org/Kizlum/hg-publishall ~/hg-publishall
+
+Then add the following to your .hgrc file in order to activate the extension:
+
+    [extensions]
+    publishall = /Users/thomas/code/hg-publishall/hg-publishall/publishall.py
+
+And voilà!
+
+Usage
+-----
+
+Add as many paths as you want to your repository/.hg/hgrc file, and when you
+want to push, use one of the following:
+
+    hg pushall
+    hg pusha
+
+Get involved
+------------
+
+Hg-publishall is licensed under MIT license, so feel free to hack as much as
+you which.
+
+The official repository is on
+[Bitbucket](http://bitbucket.org/Kizlum/hg-publishall/), but a mirror is
+available on [GitHub](http://github.com/pelletier/hg_publishall/).
+
+Finally, if you find a bug, have a feature request or want to submit a patch,
+just fill a ticket on the [issues
+tracker](http://bitbucket.org/Kizlum/hg-publishall/issues).
 #!/usr/bin/env python
 
-"""allows you to publish on all your repositories.
+"""Allows you to publish on all your repositories.
 
 Requirements:
-mercurial
+    mercurial
 
 Use:
-hg pusha
-You can also use hg pushall
+    hg pusha
+    You can also use hg pushall
 
 Installation:
-Add the following entry to the [extensions] bloc of your .hg/hgrc config.
-publishall = /path/to/publishall.py
+    Add the following entry to the [extensions] part of your .hg/hgrc config:
+        publishall = /path/to/publishall.py
+
+License:
+    MIT (see LICENSE).
+
+For more information, please read the README.markdown file.
 """
 
 from mercurial.i18n import _