diff --git a/README.md b/README.md index d57f527..8841e1f 100644 --- a/README.md +++ b/README.md @@ -33,3 +33,25 @@ i.e. replace redis with an event driven approach - [x] create event store - [x] make events - [x] implement event store + +## Usage tips + +### Running the app locally + +Install *air* from [cosmtrek/air github repo](https://github.com/cosmtrek/air) with `go install github.com/cosmtrek/air@latest` or use the provided install bash scripts. This tool will watch for changes in the project folder and rebuild and restart the app during development (at least most of the time) + +then in the root folder: + + air + +and check for errors. Normally the site will now answer on [port 8080.](http://localhost:8080) + +### Updating CSS with tailwind + +Just add tailwind tags to the *class* attributes per documentation + +then in the root folder: + + npx tailwindcss -i ./src/input.css -o ./static/output.css --watch + +Same deal, it will monitor changes in the templates and regenerate the output.css on the fly.