Add README and CHANGELOG
This commit is contained in:
parent
37b52a242b
commit
38e62f449a
23
CHANGELOG.md
Normal file
23
CHANGELOG.md
Normal 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
22
README.md
Normal file
@ -0,0 +1,22 @@
|
|||||||
|
Short - simple go url shortner
|
||||||
|
==============================
|
||||||
|
|
||||||
|
[](https://git.thebarrens.nu/wolvie/short/blob/master/LICENSE)
|
||||||
|
[](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
|
Loading…
x
Reference in New Issue
Block a user