From dea368d08ba3078d0f9b3041e4090847e53bf74c Mon Sep 17 00:00:00 2001 From: Sebastian Preisner Date: Thu, 16 Nov 2017 06:49:30 +0000 Subject: [PATCH] Rename Sgot to Shrty --- README.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 4d9731a..c804eb8 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ -# Sgot -Sgot is a lightwaight, self-hostable open-source link shortening web application with a Restful API. It allows you to host your own URL shortener to gain control over you data. Shrt is inspired by [Polr](https://polr.me/index.php), a php based url shortener. +# Shrty +Shrty is a lightwaight, self-hostable open-source link shortening web application with a Restful API. It allows you to host your own URL shortener to gain control over your data. Shrty is inspired by [Polr](https://polr.me/index.php), a php based url shortener. ## Features @@ -8,6 +8,8 @@ Sgot is a lightwaight, self-hostable open-source link shortening web application - [x] Simple database Json file - [x] Restful API - [x] Simple Click Statistik +- [ ] Key protected API +- [ ] Nice overfewpage for shorted URLs - [ ] Delete URL - [ ] Login @@ -15,15 +17,15 @@ Sgot is a lightwaight, self-hostable open-source link shortening web application Clone the Repository and build the Application by using `go build .` -Start Sgot by the following commant `./sgot &` +Start Shrty by the following commant `./sgot &` | Flag | Usage | Default | | -------- | -------------------------------------- | ------------------------------------ | | -host | setup the host to listen on | localhost | | -port | Setup the port to listen on | 6889 | | -apikey | Define the key to connect with the API | "thisIsNotASecretTokenNow" | -| -db-file | Setup the DB file to use | ./sgot.db | -| -title | Service title | Sgot | +| -db-file | Setup the DB file to use | ./shrty.db | +| -title | Service title | Shrty | | -domain | Domain for the redirection link | The domain your service is available | ## API