breve/README.md

31 lines
814 B
Markdown
Raw Normal View History

2015-04-08 23:53:34 +02:00
# Breve
### a url shortener
Breve is a web application that provides a simple interface to
2015-04-09 00:05:54 +02:00
shortening long urls creating links smaller and easier to remember.
2015-04-08 23:53:34 +02:00
2015-04-09 00:05:54 +02:00
It creates links in the form of "/emeaoinqua": easier to remember than
2015-04-08 23:53:34 +02:00
alphanumeric strings like "/1Cqw8lHw" used by several services.
2015-04-09 00:05:54 +02:00
It was inspired by [hastebin](http://hastebin.com).
## Installing the app
2015-04-09 00:05:54 +02:00
Install the app with cabal-install. Run
2015-04-08 23:53:34 +02:00
$ cabal install breve
2015-04-08 23:53:34 +02:00
and start it with
$ breve
The app will start serving on `http://localhost:3000`, listening on every active interface.
2015-04-09 17:27:04 +02:00
You can change the port and set a hostname via the `PORT` and `HOSTNAME` environment variables.
2015-04-08 23:53:34 +02:00
## License
Dual licensed under the MIT and GPL licenses:
http://www.opensource.org/licenses/mit-license.php
2015-04-09 00:05:54 +02:00
http://www.gnu.org/licenses/gpl.html