shortenit/README.md

21 lines
455 B
Markdown

# Shortenit
Shortenit is a tool to shorten urls.
**NOTE**: This is a very early draft project. Contributions are welcome.
## Install
To install `shortenit` and all of its dependencies for development, run the following script.
``` shell
$ scripts/install.sh
```
## Running
To run `shortenit` for development, edit the configuration file found in [config/config.yaml](config/config.yaml) then run the following script.
```text
$ scripts/run.sh
```