add readme

Author: martinyonatann

Makefile

@@ -42,7 +42,7 @@ e2e-test:
 	@echo "make e2e-test ${IS_IN_PROGRESS}"
 	@go clean -testcache
 	@go test --race -timeout=90s -failfast \
-		-vet= -cover -covermode=atomic -coverprofile=./.coverage/unit.out \
+		-vet= -cover -covermode=atomic -coverprofile=./.coverage/e2e.out \
 		-tags=e2e ./internal/users/delivery/...\
 
 ## tests: run tests and any dependencies

README.md

@@ -0,0 +1,21 @@
+# Go Unit Testing Example
+
+[![Go Report Card](https://goreportcard.com/badge/github.com/martinyonatann/go-unit-test)](https://goreportcard.com/report/github.com/martinyonatann/go-unit-test)
+[![Go Coverage](https://img.shields.io/badge/coverage-A+-brightgreen.svg)](https://gocov.io/github.com/martinyonatann/go-unit-test)
+
+
+This repository serves as an example for implementing unit tests in a Golang project. It demonstrates best practices for structuring your codebase to facilitate testing and includes examples of unit tests using the standard `testing` package.
+
+## Getting Started
+
+### Prerequisites
+
+Before running the tests, ensure that you have Golang installed on your machine. You can download it [here](https://golang.org/dl/).
+
+### Running Tests
+
+To run the unit tests, use the following command:
+
+```bash
+make tests
+```