update readme

README.md

@@ -1,70 +1,75 @@
-# Getting Started with Create React App
+# Crypto-Viz
 
-This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
+Crypto-Viz is a cryptocurrency volume visualization application built with React, MUI, and Observable Plot. The application visualizes cryptocurrency data such as volume and quarter-over-quarter (QoQ) changes for popular cryptocurrencies like Bitcoin, Ethereum, Solana, and USDC. The project is deployed to GitHub Pages.
 
-## Available Scripts
+## Live Demo
 
-In the project directory, you can run:
+You can view the live demo of the project at:  
+[Crypto-Viz Demo](https://sorochak.github.io/crypto-chart)
 
-### `npm start`
+## Table of Contents
 
-Runs the app in the development mode.\
-Open [http://localhost:3000](http://localhost:3000) to view it in your browser.
+- [Project Overview](#project-overview)
+- [Technologies Used](#technologies-used)
+- [Features](#features)
+- [Installation](#installation)
+- [Running the Project Locally](#running-the-project-locally)
+- [Deployment](#deployment)
 
-The page will reload when you make changes.\
-You may also see any lint errors in the console.
+## Project Overview
 
-### `npm test`
+Crypto-Viz fetches cryptocurrency volume data and visualizes it using an area chart. Users can see the average volume for each cryptocurrency in Q2'23 and how it changed compared to Q1'23. The app uses Material-UI (MUI) components for styling and layout and Observable Plot for charting.
 
-Launches the test runner in the interactive watch mode.\
-See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
+The project is deployed via GitHub Pages using the `gh-pages` branch.
 
-### `npm run build`
+## Technologies Used
 
-Builds the app for production to the `build` folder.\
-It correctly bundles React in production mode and optimizes the build for the best performance.
+- **React**
+- **Material-UI (MUI)**
+- **Observable Plot**
 
-The build is minified and the filenames include the hashes.\
-Your app is ready to be deployed!
+## Features
 
-See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
+- Area chart visualizing the volume of Bitcoin, Ethereum, Solana, and USDC.
+- Displays average volume for Q2'23 and quarter-over-quarter (QoQ) percentage changes.
+- Automated deployment to GitHub Pages using the `gh-pages` branch.
 
-### `npm run eject`
+## Installation
 
-**Note: this is a one-way operation. Once you `eject`, you can't go back!**
+To install and run the project locally, follow these steps:
 
-If you aren't satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
+1. **Clone the repository:**
+   ```bash
+   git clone https://github.com/sorochak/crypto-chart.git
+   cd crypto-viz
+   ```
+2. **Install dependencies:**
+   ```bash
+   npm install
+   ```
 
-Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.
+## Running the Project Locally
 
-You don't have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.
+1. **Start the development server:**
+   ```bash
+    npm start
+   ```
+2. **View the app:** Open your browser and go to `http://localhost:3000` to view the app.
 
-## Learn More
+## Deployment
 
-You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
+This project is deployed to GitHub Pages using the gh-pages branch. The deployment process is automated via npm scripts.
 
-To learn React, check out the [React documentation](https://reactjs.org/).
+### Steps to Deploy
 
-### Code Splitting
+1. **Build the Project:**
 
-This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting)
+   ```bash
+   npm run build
+   ```
 
-### Analyzing the Bundle Size
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size)
-
-### Making a Progressive Web App
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app)
-
-### Advanced Configuration
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration)
-
-### Deployment
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)
-
-### `npm run build` fails to minify
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)
+2. **Deploy the build to Github Pages:**
+   ```bash
+   npm run deploy
+   ```
+   This command will build the project and push the build files to the gh-pages branch, making the site available at https://sorochak.github.io/crypto-chart.