Skip to content

docs: update README for React-based architecture#114

Open
PranshuPujara wants to merge 1 commit into
Mohit-368:mainfrom
PranshuPujara:PranshuPujara-issue#100
Open

docs: update README for React-based architecture#114
PranshuPujara wants to merge 1 commit into
Mohit-368:mainfrom
PranshuPujara:PranshuPujara-issue#100

Conversation

@PranshuPujara
Copy link
Copy Markdown

Hi, @Mohit-368
This PR updates the README documentation to align with the current React + JavaScript architecture of the project.

Changes Made

  • Updated the tech stack section to reflect React, JavaScript, Vite, and modern tooling
  • Replaced outdated static HTML/CSS/JS references
  • Updated installation and setup instructions
  • Added React development workflow commands
  • Updated build and deployment instructions
  • Revised the project structure for the React-based architecture
  • Added a component structure explanation for contributors
  • Improved overall readability and beginner-friendliness of the documentation

Result

The README now accurately represents the current application structure and development workflow, making it easier for contributors and users to understand, run, and contribute to the project.

Closes #100

Thank you!
Pranshu Pujara🕵️‍♂️

@netlify
Copy link
Copy Markdown

netlify Bot commented May 15, 2026

Deploy Preview for makeareadme ready!

Name Link
🔨 Latest commit 849e889
🔍 Latest deploy log https://app.netlify.com/projects/makeareadme/deploys/6a075be865b66300086b849f
😎 Deploy Preview https://deploy-preview-114--makeareadme.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update README Documentation for React Migration

1 participant