README: Add instructios for cloning the Git repository.

diff --git a/README b/README
index ddd41cf..e9e9f15 100644 (file)
--- a/README
+++ b/README
@@ -7,9 +7,9 @@ the provided keywors is not found in the database.
 
 For example, imagine a user opening this URL:
 
-  http://sho.rt/a06c1a52
+  http://sho.rt/3f14d8fa
 
-And further imagine that “a06c1a52” is not a short URL stored in the database.
+And further imagine that “3f14d8fa” is not a short URL stored in the database.
 This plugin will intercept the “redirect_keyword_not_found” action and check if
 the keyword is a hexadecimal number with at least six (hexadecimal) digits.
 
@@ -18,12 +18,17 @@ and check if there's an object in one of them which matches the given id. If
 such an object is found, the user will be redirected to the appropriate Gitweb
 page. Otherwise, YOURLS will proceed as usual.
 
+
 Installation
 ------------
 First, you need at least YOURLS, version 1.5. Versions before that do not
 provide a plugin infrastructure.
 
- * Copy the plugin to “$yourls_dir/user/plugins/”.
+ * Copy the plugin to “$yourls_dir/user/plugins/”. To check out the Git
+   repository change into this directory and run:
+
+     $ git clone git://git.verplant.org/yourls-gitweb.git gitweb
+
  * Open the administrative interface in the web-browser of your choice.
  * Open the “Plugins” page and search for the “Gitweb” plugin in the table.
  * Click “Activate” in the rightmost “Action” column.
@@ -35,6 +40,7 @@ provide a plugin infrastructure.
    superfluous arguments are automatically stripped.
  * Click “Update” to store your changes.
 
+
 Caveats
 -------
 The plugin executes the “git” command line utility to check for objects in the
@@ -47,12 +53,14 @@ PHP's “safe mode” is activated. The commands used are:
  * git cat-file
    Determine an object's type.
 
+
 License
 -------
 The “Gitweb” plugin is distributed under the terms of the MIT license. The
 complete licensing terms can be found at the beginning of the file
 “plugin.php”.
 
+
 Author
 ------
 Florian “octo” Forster <ff at octo.it>