docs: update readme

README.md

@@ -1,30 +1,27 @@
-# React + TypeScript + Vite
+# My Timetable
 
-This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
+Timetable planner for University of Adelaide students
 
-Currently, two official plugins are available:
+## Development
 
-- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
-- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
+1. Install the dependencies
 
-## Expanding the ESLint configuration
+```sh
+pnpm i
+```
 
-If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:
+2. Copy `.env.example` to a new file `.env`
 
-- Configure the top-level `parserOptions` property like this:
+3. Run the development server
 
-```js
-export default {
-	// other rules...
-	parserOptions: {
-		ecmaVersion: 'latest',
-		sourceType: 'module',
-		project: ['./tsconfig.json', './tsconfig.node.json'],
-		tsconfigRootDir: __dirname,
-	},
-};
+```sh
+pnpm run dev
 ```
 
-- Replace `plugin:@typescript-eslint/recommended` to `plugin:@typescript-eslint/recommended-type-checked` or `plugin:@typescript-eslint/strict-type-checked`
-- Optionally add `plugin:@typescript-eslint/stylistic-type-checked`
-- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and add `plugin:react/recommended` & `plugin:react/jsx-runtime` to the `extends` list
+4. Open <http://localhost:5173> with your browser to see the result.
+
+5. (Optional) Run the tests
+
+```sh
+pnpm run test
+```