Update description

master
Michele Guerini Rocco 2015-04-09 00:05:54 +02:00
parent a616d27f71
commit a2ea5974a6
1 changed files with 7 additions and 5 deletions

View File

@ -2,13 +2,15 @@
### a url shortener
Breve is a web application that provides a simple interface to
shortening long urls creating smaller and easy to remember links.
shortening long urls creating links smaller and easier to remember.
It creates links like "/emeaoinqua" that easier to remember than
It creates links in the form of "/emeaoinqua": easier to remember than
alphanumeric strings like "/1Cqw8lHw" used by several services.
It was inspired by [hastebin](http://hastebin.com).
## Running the app
git clone https://github.com/rnhmjoj/breve
cd breve
cabal install --only-dependencies
@ -17,10 +19,10 @@ alphanumeric strings like "/1Cqw8lHw" used by several services.
This will start the app on `http://127.0.0.1:3000`
You can set the bind hostname/port via the `PORT` and `ADDRESS`
environment variables
environment variables.
## License
Dual licensed under the MIT and GPL licenses:
http://www.opensource.org/licenses/mit-license.php
http://www.gnu.org/licenses/gpl.html
http://www.gnu.org/licenses/gpl.html