Add readme
This commit is contained in:
parent
edc7bd175e
commit
a616d27f71
26
README.md
Normal file
26
README.md
Normal file
@ -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
|
Loading…
Reference in New Issue
Block a user