From 7b4935ad5d856f33d79f7076319f75680fd85bce Mon Sep 17 00:00:00 2001 From: Michael Bradley Date: Fri, 3 Jan 2025 00:57:56 +1300 Subject: [PATCH] Update README --- README.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index e58e75c..cff41ed 100755 --- a/README.md +++ b/README.md @@ -1,9 +1,12 @@ -# [mmbradley.ca](https://mmbradley.ca) +# Personal website -A basic static personal website. -Contains some basic information about me along with some of my interests. +A basic static personal website, made using TypeScript/React/Vite. +It contains some basic information about me along with some relevant links. -## TODO +It is deployed at [mmbradley.ca](https://mmbradley.ca). -* TODOs in files -* Automate minifying and push to site? +## Deployment + +The site is build with React and local development can be done with React devtools, but the site is ultimately static. +`render.sh` calls `vite build` to process the assets and prepare the site for rendering. +It then has `node` render the site, and outputs everything needed to display the site to the `dist/prod` directory.