Commit 648a1546 authored by Luc Didry's avatar Luc Didry

Update Readme.md

Correct markdown + change URL to git.framasoft.org instead of github
parent c13b79c1
#LSTU
##What LSTU means ?
## What LSTU means ?
It means Let's Shorten That Url.
##License
## License
Lstu is licensed under the terms of the WTFPL. See the LICENSE file.
##Dependancies
## Dependancies
* Carton : Perl dependancies manager, it will get what you need, so don't bother for dependancies (but you can read the file `cpanfile` if you want).
```shell
sudo cpan Carton
```
##Installation
## Installation
After installing Carton :
```shell
git clone https://github.com/ldidry/lstu.git
git clone https://git.framasoft.org/luc/lstu.git
cd lstu
carton install
cp lstu.conf.template lstu.conf
```
##Usage
## Usage
```
carton exec hypnotoad script/lstu
```
......@@ -31,7 +31,7 @@ Yup, that's all, it will listen at "http://127.0.0.1:8080".
For more options (interfaces, user, etc.), change the configuration in `lstu.conf` (have a look at http://mojolicio.us/perldoc/Mojo/Server/Hypnotoad#SETTINGS for the available options).
##How many urls can it handle ?
## How many urls can it handle ?
Well, by default, there is 8 361 453 672 available combinations. I think the sqlite db will explod before you reach this limit. If you want more shortened URLs than that, open `lstu.conf` and change the `length` setting.
Everytime somebody uses LSTU, it will create 'waiting' shortened URLs codes in order to be quick to shorten the URLs.
......@@ -49,13 +49,13 @@ UPDATE SQLITE_MASTER SET SQL = 'CREATE TABLE lstu (short TEXT PRIMARY KEY, url T
PRAGMA writable_schema = 0;
```
##Other options
## Other options
Well, there is the `contact` option, where you a to put some way for the users to contact you, and the `secret` where you have to put a random string in order to protect your Mojolicious cookies (not really useful and optional).
##Reverse proxy
## Reverse proxy
You can use a reverse proxy like Nginx or Varnish (or Apache with the mod\_proxy module). The web is full of tutos.
##Internationalization
## Internationalization
LSTU comes with english and french languages. It will choose the language to display with the browser's settings.
If you want to add more languages, for example german:
......@@ -67,10 +67,10 @@ vim de.pm
There's just a few sentences, so it will be quick to translate. Please consider to send me you language file in order to help the other users :smile:.
##Official instance
## Official instance
You can see it working and use it at http://lstu.fr.
##API
## API
You can shorten an URL with a GET request:
`http://lstu.fr/a?lsturl=http://example.com&format=json`
......@@ -79,5 +79,5 @@ With `format=json`, you will get a json string like that:
If you don't use `format=json`, you will be redirected to http://lstu.fr where the shortened URL informations will be displayed.
##Others projects dependancies
Lstu is written in Perl with the Mojolicious framework and uses the Twitter bootstrap framework to look not too ugly.
## Others projects dependancies
Lstu is written in Perl with the Mojolicious framework and uses the Twitter bootstrap framework to look not too ugly.
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment