docs: update readme with project specifics

README.md

@@ -1,22 +1,19 @@
-# create-svelte
+# bvdget
 
-Everything you need to build a Svelte project, powered by [`create-svelte`](https://github.com/sveltejs/kit/tree/main/packages/create-svelte).
+A money tracking app to make it easy to keep a handle on your money habits.
 
-## Creating a project
+## Developing
 
-If you're seeing this, you've probably already done this step. Congrats!
+You will need the [LTS version of Node.js](https://nodejs.org) to run this project.
 
 ```bash
-# create a new project in the current directory
-npm create svelte@latest
-
-# create a new project in my-app
-npm create svelte@latest my-app
+# install dependencies
+npm install
 ```
 
-## Developing
+Before running the project for the first time, you will need to set up some environment variables. Copy the contents of `.env.example` into a file called `.env`, and fill in the values based on the comments telling you where to find the secrets.
 
-Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
+Now you should be able to start the development server:
 
 ```bash
 npm run dev
@@ -27,12 +24,39 @@ npm run dev -- --open
 
 ## Building
 
-To create a production version of your app:
+To create a production build:
 
 ```bash
 npm run build
 ```
 
 You can preview the production build with `npm run preview`.
 
-> To deploy your app, you may need to install an [adapter](https://kit.svelte.dev/docs/adapters) for your target environment.
+## Deploying
+
+The production app is deployed to Netlify on every push to `main`. Deploy previews are deployed for all pull requests against `main`. The environment variables that you use for local development match the ones used for deploy previews, so that test data should be available both locally and in previews. The production environment is kept separate and those environment variables should only be used locally to fix production-specific issues.
+
+## Linting & Testing
+
+Every PR requires the `lint` and `test` scripts to succeed before merging.
+
+```bash
+# run the linters
+npm run lint
+
+# format files with prettier
+npm run format
+
+# run all tests
+npm run test
+
+# only run unit tests
+npm run test:unit
+
+# only run integration tests
+npm run test:integration
+```
+
+## Conventional Commits
+
+This project uses [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/), and any PRs with non-conforming commit messages will need to be updated before merging to `main`.