X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=README;h=a4ac3258004608acd478bb30b514d42e9f456d81;hb=HEAD;hp=ddd41cf76cb1c816f031b2d9ea6cf4ab178c155a;hpb=c09f76fec824ffdf8fe3a24beb6a498f0f4215d8;p=yourls-gitweb.git
diff --git a/README b/README
index ddd41cf..a4ac325 100644
--- a/README
+++ b/README
@@ -3,13 +3,13 @@ Gitweb plugin for YOURLS
This plugin can be used to automatically redirect to a Gitweb installation, if
-the provided keywors is not found in the database.
+the provided keyword 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