From 3c721a4ae15e6a3f8e9c12e1398e3e58ad7f74ee Mon Sep 17 00:00:00 2001
From: Alex Leung <alexwkleung25@gmail.com>
Date: Wed, 1 Jan 2025 10:22:16 -0800
Subject: [PATCH] Update README

---
 README.md | 61 +++++++++++++++++++------------------------------------
 1 file changed, 21 insertions(+), 40 deletions(-)

diff --git a/README.md b/README.md
index 1e5a46b..261fc89 100644
--- a/README.md
+++ b/README.md
@@ -1,50 +1,31 @@
-# React + TypeScript + Vite
+# Dashboard Data Viz Example Template
 
-This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
+A dashboard data vizualization example using React, Highcharts, and Material UI Data Grid.
 
-Currently, two official plugins are available:
+As of now this is not 100% complete.
 
-- [@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
+# Setup
 
-## Expanding the ESLint configuration
+Clone repository
 
-If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:
+Install dependencies
 
-- Configure the top-level `parserOptions` property like this:
+```bash
+npm install
+```
+
+Run unit tests
 
-```js
-export default tseslint.config({
-  languageOptions: {
-    // other options...
-    parserOptions: {
-      project: ['./tsconfig.node.json', './tsconfig.app.json'],
-      tsconfigRootDir: import.meta.dirname,
-    },
-  },
-});
+```bash
+npm run test
 ```
 
-- Replace `tseslint.configs.recommended` to `tseslint.configs.recommendedTypeChecked` or `tseslint.configs.strictTypeChecked`
-- Optionally add `...tseslint.configs.stylisticTypeChecked`
-- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and update the config:
-
-```js
-// eslint.config.js
-import react from 'eslint-plugin-react';
-
-export default tseslint.config({
-  // Set the react version
-  settings: { react: { version: '18.3' } },
-  plugins: {
-    // Add the react plugin
-    react,
-  },
-  rules: {
-    // other rules...
-    // Enable its recommended rules
-    ...react.configs.recommended.rules,
-    ...react.configs['jsx-runtime'].rules,
-  },
-});
+Run local development server
+
+```bash
+npm run dev
 ```
+
+# License
+
+MIT License.