From c7c87a4176410340594d9c72a8311fe7ffbfe236 Mon Sep 17 00:00:00 2001
From: puni9869 <80308335+puni9869@users.noreply.github.com>
Date: Fri, 27 Dec 2024 13:56:38 +0530
Subject: [PATCH] chore: updated README.MD

---
 README.md | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/README.md b/README.md
index 1bb3564..4638f8a 100644
--- a/README.md
+++ b/README.md
@@ -2,8 +2,21 @@
 
 [![Check](https://github.com/puni9869/pinmyblogs/actions/workflows/go.yml/badge.svg)](https://github.com/puni9869/pinmyblogs/actions/workflows/go.yml)
 
+### How to start
+1. You need latest Go runtime. https://go.dev
+2. `export ENVIRONMENT=local`
+3. Run `make watch server`. This is a live hot reloading server config. Uses https://github.com/air-verse/air
+4. For unit test run `make test`.
+5. For vulnerability check run `make govulncheck  && make vet`.
+6. To check static errors run `make lint`.
+
+
 ### Create a super user in posgtres:
 
 > CREATE USER <username> WITH SUPERUSER PASSWORD '';
 
 > CREATE USER puni9869 SUPERUSER;
+
+### How to contact
+1. Create an issue and raise your concern, bug and feature request. I will be happy to address run-time.
+2. Reachout to me on [Linkedin](https://www.linkedin.com/in/punitinani1/)