From 2cbbc67467c6c8f513ec848961f73d58e86405c2 Mon Sep 17 00:00:00 2001
From: Guilherme Rugai Freire <dev@grfreire.com>
Date: Wed, 10 Jul 2024 19:19:09 -0300
Subject: [PATCH] update getting started docs

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

diff --git a/README.md b/README.md
index b3efc98..2f773b1 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,39 @@
 
 A temporary email service
 
+## Getting Started
+
+### Compiling
+
+Requirements:
+ - Golang
+ - Templ
+ - Make
+
+```sh
+make
+```
+
+### Creating a database:
+
+Requirements:
+ - SQLite
+
+```sh
+cat migration.sql | sqlite3 db.db
+```
+
+### Running:
+
+Available env variables:
+ - WEB_SERVER_PORT
+ - MAIL_SERVER_PORT
+ - MAIL_SERVER_DOMAIN
+
+```sh
+./bin/server
+```
+
 ## TODO
 
  - Restart when either mail or web server dies