Add README and CHANGELOG

This commit is contained in:
Tom Andrade 2019-03-18 16:46:39 +01:00
parent 37b52a242b
commit 38e62f449a
Signed by: wolvie
GPG Key ID: 31AAB07872E82669
2 changed files with 45 additions and 0 deletions

23
CHANGELOG.md Normal file
View File

@ -0,0 +1,23 @@
# Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
## 2019-03-18
### Added
- gitlab CI configuration
- Add version
- Add License
- Add Dockerfile for building standalone image
- shortener initial version
- Initial commit
- Changelog.md
- Readme.md
- License
### Changed
### Removed

22
README.md Normal file
View File

@ -0,0 +1,22 @@
Short - simple go url shortner
==============================
[![License](https://img.shields.io/badge/license-MIT-green.svg)](https://git.thebarrens.nu/wolvie/short/blob/master/LICENSE)
[![Build Status](https://git.thebarrens.nu/wolvie/short/badges/master/build.svg)](https://git.thebarrens.nu/wolvie/short/)
Short is a very simple url shortener build in golang using web.go module and redis (redigo) for storring URLs
Syntax is:
```shell
Usage of /short:
-addr string
Address to listen for connections (default "localhost:8080")
-domain string
Domain to write to the URLs (default "localhost")
-redis string
ip/hostname of the redis server to connect (default "localhost:6379")
-v prints current roxy version
```
Includes a Dockerfile to for a standalone docker image