From fb015ee4dba48d91fc0e577d0f39c5c11da8e7da Mon Sep 17 00:00:00 2001 From: Phyks Date: Thu, 17 Oct 2013 14:00:00 +0100 Subject: [PATCH] Doc updated --- README.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a6fd2e9..5ab8e3c 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,21 @@ shortURL ======== -Forked from http://git.cphyc.me/cgit.cgi/tinyURL +This is a small one-file script to shorten URLs, _à la_ bitly or tinyURL. + +# Installation + +Just put the `index.php` file in a writeable directory behind your webserver. + +Edit the first lines of the `index.php` file (config) to fit your configuration. + +You are ready to use it ! + +Links will be stored in the file specified in config, as serialized gzip php array. + +# LICENSE +This script is a fork from http://git.cphyc.me/cgit.cgi/tinyURL, written by cphyc. + +I don't give a damn to the modifications I made to this script and there was no license specified on the original repo. So, I think you can reuse it freely (or contact [cphyc](https://github.com/cphyc/) for more info). + +As usual, if you find it useful and reuse it, it's always nice to cite the original author. Furthermore, if you find it useful, and if we ever meet some day, you can buy me a beer soda in return, if you think it's worth it :)