Skip to content

docs: Update README to reflect React + Vite architecture#107

Open
tanishrajh wants to merge 1 commit into
Mohit-368:mainfrom
tanishrajh:update-readme-react
Open

docs: Update README to reflect React + Vite architecture#107
tanishrajh wants to merge 1 commit into
Mohit-368:mainfrom
tanishrajh:update-readme-react

Conversation

@tanishrajh
Copy link
Copy Markdown

📝 Description

ISSUE #100

Fixes: Update outdated documentation to reflect the new React architecture

This Pull Request updates the README.md to accurately reflect the project's migration from a static HTML/CSS/JavaScript stack to a modern React + Vite application. It ensures that contributors and users are presented with up-to-date prerequisites, installation steps, and project structural information.

🛠️ Changes Made

  • Tech Stack Updates: Replaced the legacy "Made with HTML" badge with a new "React + Vite" badge.
  • Improved Presentation: Centered the primary heading, badges, links, and screenshots to create a cleaner, more professional landing page layout.
  • Updated Setup Instructions: Rewrote the "Getting Started" section to explicitly require Node.js and outline standard npm commands (npm install, npm run dev).
  • Added Script Documentation: Added an "Available Scripts" section detailing dev, build, and preview commands.
  • Modernized Structure Diagram: Swapped the old static file tree with the new React component-based folder hierarchy (showing src/, components/, hooks/, etc.).
  • General Clean-up: Removed legacy text mentioning "zero dependencies" and "pure HTML/CSS" from the feature list and footer.

🧪 How to Verify

  1. Pull this branch (update-readme-react).
  2. Review the README.md visually on GitHub or through a local Markdown preview tool.
  3. Verify that the command instructions line up perfectly with the actual developer workflow for the ReadmeForge Vite setup.

@netlify
Copy link
Copy Markdown

netlify Bot commented May 15, 2026

Deploy Preview for makeareadme ready!

Name Link
🔨 Latest commit 0527e57
🔍 Latest deploy log https://app.netlify.com/projects/makeareadme/deploys/6a06cfc49490de0008f5129b
😎 Deploy Preview https://deploy-preview-107--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.

@tanishrajh
Copy link
Copy Markdown
Author

hey @Mohit-368 i have updated the readme. verify it

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.

1 participant