diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..0a309b88d5041d4454b8b227e3a8c3e8ce01947b --- /dev/null +++ b/README.md @@ -0,0 +1,20 @@ +Webservice +========== + +A Go-based simple web service meant to be the subject for any tutorial +or even the project work. + + +__Prerequisites:__ + +* Go toolchain (install via system package manager or [by hand](https://go.dev/doc/install)) + + +__Main interactions:__ + +1. Install dependencies: `go get -t ./...` +2. Run locally: `go run .` +3. Execute unit tests: `go test -race -v ./...` +4. Build artifact: `go build -o ./artifact.bin ./*.go` + +For more details, please refer to the `Makefile`.