From a616d27f7127509ce884054e5c33fc23608215c7 Mon Sep 17 00:00:00 2001 From: rnhmjoj Date: Wed, 8 Apr 2015 23:53:34 +0200 Subject: [PATCH] Add readme --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..d8dc3a6 --- /dev/null +++ b/README.md @@ -0,0 +1,26 @@ +# Breve +### a url shortener + +Breve is a web application that provides a simple interface to +shortening long urls creating smaller and easy to remember links. + +It creates links like "/emeaoinqua" that easier to remember than +alphanumeric strings like "/1Cqw8lHw" used by several services. + +## Running the app + + git clone https://github.com/rnhmjoj/breve + cd breve + cabal install --only-dependencies + cabal run + +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 + +## License + +Dual licensed under the MIT and GPL licenses: +http://www.opensource.org/licenses/mit-license.php +http://www.gnu.org/licenses/gpl.html \ No newline at end of file