diff --git a/README.md b/README.md index 066e9a0..7802398 100644 --- a/README.md +++ b/README.md @@ -10,9 +10,12 @@ This is my personal website! ## Requirements: - Golang 1.23.1 -## Instructions: -1. Run ```go get``` -2. Duplicate the .env.example file and call it .env -3. Fill out the required .env values -4. Run ```go install github.com/air-verse/air@latest``` to download Air for live reload -5. Run ```air``` to start the dev server (macOS and Linux only) +## Getting Started +1. Clone this repository +2. Copy `.env.example` to `.env` +3. Run `go mod download` +4. Start the server: `go run main.go` + +## 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