Add README.md

README.md

@@ -0,0 +1,45 @@
+[![Go Doc](https://pkg.go.dev/badge/github.com/benalucorp/library-template-go?status.svg)](https://pkg.go.dev/github.com/benalucorp/library-template-go?tab=doc)
+[![Release](https://img.shields.io/github/release/benalucorp/library-template-go.svg?style=flat-square)](https://github.com/benalucorp/library-template-go/releases)
+[![Go Report Card](https://goreportcard.com/badge/github.com/benalucorp/library-template-go)](https://goreportcard.com/report/github.com/benalucorp/library-template-go)
+[![Build Status](https://github.com/benalucorp/library-template-go/workflows/Go/badge.svg?branch=main)](https://github.com/benalucorp/library-template-go/actions?query=branch%3Amain)
+[![Sourcegraph](https://sourcegraph.com/github.com/benalucorp/library-template-go/-/badge.svg)](https://sourcegraph.com/github.com/benalucorp/library-template-go?badge)
+[![TODOs](https://badgen.net/https/api.tickgit.com/badgen/github.com/benalucorp/library-template-go)](https://www.tickgit.com/browse?repo=github.com/benalucorp/library-template-go)
+
+![gdk](https://socialify.git.ci/benalucorp/library-template-go/image?description=1&language=1&owner=1&pattern=Floating%20Cogs&theme=Light)
+
+## Getting Started
+
+// TODO: replace me
+
+## Installation
+
+```shell
+# TODO: replace me
+go get -v github.com/benalucorp/library-template-go
+```
+
+## Quick Start
+
+```go
+// TODO: replace me
+```
+
+For more example check [here](main_integration_test.go).
+
+## Test Double / Stub
+
+Sometime it's make sense to make an API call without actually calling the API. In order to support that this library has a built-in stub that can be triggered. You can enable stub by injecting certain value to the context data. You can also enforce that certain API call will always return error with specific type and
+message.
+
+```go
+// TODO: replace me
+```
+
+For more example, check [here]().
+
+## Supported API
+
+Version: // TODO: replace me
+
+- [// TODO: replace me]()
+   - [// TODO: replace me]()