README

README.md

@@ -10,9 +10,12 @@ This is my personal website!
 ## Requirements:
 - Golang 1.23.1
 
-## Instructions:
+## Getting Started
-1. Run ```go get```
+1. Clone this repository
-2. Duplicate the .env.example file and call it .env
+2. Copy `.env.example` to `.env`
-3. Fill out the required .env values
+3. Run `go mod download`
-4. Run ```go install github.com/air-verse/air@latest``` to download Air for live reload
+4. Start the server: `go run main.go`
-5. Run ```air``` to start the dev server (macOS and Linux only)
+
+## API Documentation
+1. Install swag by running ```go install github.com/swaggo/swag/cmd/swag@latest```
+2. Visit `/api/swagger/index.html` after starting the server