Skip to content

docs: update README to reflect React + Vite migration#112

Open
nehakathayat8077 wants to merge 1 commit into
Mohit-368:mainfrom
nehakathayat8077:fix/update-readme-react-migration
Open

docs: update README to reflect React + Vite migration#112
nehakathayat8077 wants to merge 1 commit into
Mohit-368:mainfrom
nehakathayat8077:fix/update-readme-react-migration

Conversation

@nehakathayat8077
Copy link
Copy Markdown

What this PR does

Fixes #100

The README was outdated and still referenced the old static
HTML/CSS/JS implementation. This PR updates it to reflect
the current React + Vite architecture.

Changes made

  • Updated tech stack section to React 18, React Router DOM, Vite 5
  • Replaced old project structure with React-based structure
  • Updated installation steps to use npm install and npm run dev
  • Added Available Scripts table with dev/build/preview commands
  • Updated badges to show React and Vite instead of HTML/JS/CSS
  • Kept Open Source section, Screenshots, Roadmap and Author intact
  • Removed references to opening index.html directly in browser

@netlify
Copy link
Copy Markdown

netlify Bot commented May 15, 2026

Deploy Preview for makeareadme ready!

Name Link
🔨 Latest commit 204f598
🔍 Latest deploy log https://app.netlify.com/projects/makeareadme/deploys/6a071326b4e7320008d1de5c
😎 Deploy Preview https://deploy-preview-112--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