sync README style with others

[git-mirror.git] / README.rst

diff --git a/README.rst b/README.rst
index 251849885838e066f2565bc6b7893cde98bbf145..cd4a0a350cbdd693cb734b2960078964c24ea0b1 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -1,4 +1,4 @@
-git-mirror - Sync your git repositories
+git-mirror: Sync your git repositories

 =======================================
 
 Introduction
 =======================================
 
 Introduction


@@ -102,12 +102,12 @@ found.``.
 The next step is to add this as a webhook to the GitHub repository you want to 
 sync with, to create a fresh SSH key and configure it as deployment key for the 
 repository, and to configure git-mirror accordingly. For additional security, 
 The next step is to add this as a webhook to the GitHub repository you want to 
 sync with, to create a fresh SSH key and configure it as deployment key for the 
 repository, and to configure git-mirror accordingly. For additional security, 

-one shouldalso configure a shared HMAC secret, such that the webhook can verify 
+one should also configure a shared HMAC secret, such that the webhook can verify 

 that the data indeed comes from GitHub.
 
 To make your job easier, there is a script ``github-add-hooks.py`` that can do 
 all this for you. It assumes that the repository exists on the GitHub side, but 
 that the data indeed comes from GitHub.
 
 To make your job easier, there is a script ``github-add-hooks.py`` that can do 
 all this for you. It assumes that the repository exists on the GitHub side, but 

-has not yet been configure for git-mirror, neither locally nor remotely.
+has not yet been configured for git-mirror at all.

 
 To give the script access to your repositories, you need to create an access 
 token for it. Go to "Personal Access Tokens" in your GitHub configuration, and 
 
 To give the script access to your repositories, you need to create an access 
 token for it. Go to "Personal Access Tokens" in your GitHub configuration, and 


@@ -120,19 +120,22 @@ below ``mail-sender``)::
 
 Now you can call the automatic setup script as follows::
 
 
 Now you can call the automatic setup script as follows::
 

-  ./github-add-hooks.py -o UserName -e email@example.com -l ~/repositories/repo-name.git/ -n github-repo-name
+  ./github-add-hooks.py -o UserName -e email@example.com \
+    -l ~/repositories/repo-name.git/ -n github-repo-name

 
 Notice that the username is case-sensitive! This will do all the setup on the 
 GitHub side, and it will add an appropriate configuration block to your local 
 
 Notice that the username is case-sensitive! This will do all the setup on the 
 GitHub side, and it will add an appropriate configuration block to your local 

-``git-mirror.conf``. You will still have to manually add the local git hook to 
-gitolite.
+``git-mirror.conf``. You still have to manually add the local git hook to 
+gitolite. Once you are done, any push happening to either gitolite or GitHub
+will be visible on the other side immediately. This applies even to pull
+requests that you merge in the GitHub web interface.

 
 Source, License
 ---------------
 
 You can find the sources in the `git repository`_ (also available `on GitHub`_). 
 
 Source, License
 ---------------
 
 You can find the sources in the `git repository`_ (also available `on GitHub`_). 

-They are provided under a `2-clause BSD license`_. See the file ``LICENSE-BSD`` 
-for more details.
+Guess what, the two are synced with this tool ;-) . They are provided under a 
+`2-clause BSD license`_. See the file ``LICENSE-BSD`` for more details.

 
 .. _git repository: http://www.ralfj.de/git/git-mirror.git
 .. _on GitHub: https://github.com/RalfJung/git-mirror
 
 .. _git repository: http://www.ralfj.de/git/git-mirror.git
 .. _on GitHub: https://github.com/RalfJung/git-mirror