From 841267f4b84c9b0055dad2d531b69465ef8a893a Mon Sep 17 00:00:00 2001
From: xanderjakeq <13279523+xanderjakeq@users.noreply.github.com>
Date: Mon, 17 Jun 2024 15:51:00 -0400
Subject: [PATCH] update readme

---
 readme.md | 29 +++++++++++++++++++++++++----
 1 file changed, 25 insertions(+), 4 deletions(-)

diff --git a/readme.md b/readme.md
index bcb2564..6a7f6b5 100644
--- a/readme.md
+++ b/readme.md
@@ -49,9 +49,13 @@ is the custom height (10 by default). everything else will be kept
 
 paragraphs should be written in one line
 
-### cli
-write the input file and save it as `whatever.txt`
+### server
+download a release (should be at the top right on github >^)
 
+go to the bin server and double click the server binary. copy paste this 
+link on your browser: http://localhost:3000
+
+### input format
 format:
 ```
 template_file_name
@@ -77,15 +81,32 @@ to add a nickname to use instead of the firstname, do `firstname|nickname
 lastname` on the `[full_names]` line. if the firstname or nickname is more than
 one word, use underscore like `John_Paul` or `Mr._J`
 
+click generate and the output folder should open.
+
+### cli
+write the input file and save it as `whatever.txt`
+
+the same import format applies
+
 generate pdfs
 ```
 ./path_to_letter_generator_executable ./whatever.txt
 ```
-
-output pdfs are placed in a directory named `output_today's_date/`
+output pdfs are placed in a directory named `pdf_output/date/`
 
 ## dev
 
+install: go, make, air
+```
+go mod download #install deps
+
+make air #run air to watch server files 
+make tailwind #run tailwind cli and watch for file changes in server dir
+
+make build #build cli and server binaries
+make export_server #build and copy binary and static files to `output/` dir
+```
+
 [maroto](https://github.com/johnfercher/maroto)
 - generate pdfs