diff --git a/README.md b/README.md index 5f85225..e74ad48 100644 --- a/README.md +++ b/README.md @@ -18,11 +18,14 @@ ### Standard +Since we don't provide prebuild binaries, you have to build it yourself. For that you need golang and git installed on your system. + ```bash -git clone https://github.com/maxibanki/golang-url-shortener -go get -v ./... -go build -./golang-url-shortener +git clone https://github.com/maxibanki/golang-url-shortener # Clone repository +cd golang-url-shortener # Go into it +go get -v ./... # Fetch dependencies +go build # Build executable +./golang-url-shortener # Run it ``` ### Docker Compose @@ -64,9 +67,6 @@ After you've done this, you need to set it as your standard URL Shortener. For t - Authentification - Deletion -- Github publishing -- Add shields: - - downloads - - travis - - godoc - - license \ No newline at end of file +- Add Curl Examples +- Test docker-compose installation +- Spell checker \ No newline at end of file diff --git a/store/store.go b/store/store.go index 4f77b50..66201a9 100644 --- a/store/store.go +++ b/store/store.go @@ -1,4 +1,4 @@ -// Package store provides support to intergate with the entries easily +// Package store provides support to intergate with the entries package store import (