udpate readme.md

Author: danielviki

README.md

@@ -1,20 +1,22 @@
 # Sorting Algorithm Visualizer
 
-A web application that visualizes various sorting algorithms using Vue.js frontend and Flask backend.
+A web application that visualizes various sorting algorithms using Vue.js frontend and Flask backend. Watch and learn how different sorting algorithms work through interactive step-by-step visualization.
 
 ## Features
 
 - Multiple sorting algorithms supported:
-  - Bubble Sort
-  - Selection Sort
-  - Insertion Sort
-  - Merge Sort
-  - Quick Sort
-  - Shell Sort
-  - Heap Sort
+  - Bubble Sort (O(n²))
+  - Selection Sort (O(n²))
+  - Insertion Sort (O(n²))
+  - Merge Sort (O(n log n))
+  - Quick Sort (O(n log n))
+  - Shell Sort (O(n log n))
+  - Heap Sort (O(n log n))
 - Step-by-step visualization of sorting process
 - Interactive user interface
 - Real-time sorting progress display
+- Algorithm time complexity information
+- Color-coded array elements to track changes
 
 ## Project Structure
 
@@ -24,6 +26,7 @@ sorting-visualizer/
 │   ├── src/
 │   │   ├── main.js    # Vue application entry
 │   │   ├── App.vue    # Root component
+│   │   ├── components/ # Vue components
 │   │   └── assets/    # Static assets
 │   ├── vite.config.js
 │   └── package.json
@@ -37,35 +40,37 @@ sorting-visualizer/
 ## Technology Stack
 
 - Frontend:
-  - Vue.js 3
-  - Vite
-  - Modern CSS
+  - Vue.js 3 (Composition API)
+  - Vite (Build tool)
+  - Modern CSS with animations
+  - Axios for API calls
 - Backend:
-  - Python 3
-  - Flask
-  - Flask-CORS
+  - Python 3.8+
+  - Flask (Web framework)
+  - Flask-CORS (Cross-origin support)
 
 ## Getting Started
 
 ### Prerequisites
 
 - Node.js (v14+)
 - Python (v3.8+)
-- pip
+- pip (Python package manager)
+- Git
 
 ### Installation
 
 1. Clone the repository:
 ```bash
-git clone <repository-url>
+git clone https://github.com/yourusername/sorting-visualizer.git
 cd sorting-visualizer
 ```
 
 2. Set up the backend:
 ```bash
 cd backend
 python -m venv venv
-source venv/bin/activate  # On macOS
+source venv/bin/activate  # On macOS/Linux
 pip install -r requirements.txt
 ```
 
@@ -80,7 +85,8 @@ npm install
 1. Start the Flask backend:
 ```bash
 cd backend
-source venv/bin/activate  # On macOS
+source venv/bin/activate  # On macOS/Linux
+export FLASK_ENV=development  # For development mode
 python app.py
 ```
 
@@ -98,15 +104,41 @@ http://localhost:5173
 ## Usage
 
 1. Select a sorting algorithm from the dropdown menu
-2. Enter 5 numbers in the input fields
+2. Enter numbers (5-15 recommended) in the input fields
 3. Click "Sort Numbers" to start the visualization
-4. Watch the step-by-step sorting process
-5. View the final sorted result
+4. Use controls to:
+   - Play/Pause the visualization
+   - Step forward/backward
+   - Reset the array
+5. View the current step description and array state
+6. See the final sorted result
+
+## Algorithm Details
+
+| Algorithm      | Best Case  | Average Case | Worst Case | Space Complexity |
+|---------------|------------|--------------|------------|------------------|
+| Bubble Sort   | O(n)       | O(n²)        | O(n²)      | O(1)            |
+| Selection Sort| O(n²)      | O(n²)        | O(n²)      | O(1)            |
+| Insertion Sort| O(n)       | O(n²)        | O(n²)      | O(1)            |
+| Merge Sort    | O(n log n) | O(n log n)   | O(n log n) | O(n)            |
+| Quick Sort    | O(n log n) | O(n log n)   | O(n²)      | O(log n)        |
+| Shell Sort    | O(n log n) | O(n log n)   | O(n²)      | O(1)            |
+| Heap Sort     | O(n log n) | O(n log n)   | O(n log n) | O(1)            |
 
 ## Contributing
 
-Feel free to submit issues and enhancement requests.
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
+3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
+4. Push to the branch (`git push origin feature/AmazingFeature`)
+5. Open a Pull Request
 
 ## License
 
-This project is licensed under the MIT License - see the LICENSE file for details.
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Acknowledgments
+
+- Algorithm visualizations inspired by various computer science resources
+- Vue.js and Flask communities for excellent documentation
+- Contributors and users of this project