Skip to content

docs: improve README with badges, folder structure, and fix typo (#1) - #2

Open
kazi716 wants to merge 1 commit into
amitpaul2004:mainfrom
kazi716:docs/improve-readme
Open

docs: improve README with badges, folder structure, and fix typo (#1)#2
kazi716 wants to merge 1 commit into
amitpaul2004:mainfrom
kazi716:docs/improve-readme

Conversation

@kazi716

@kazi716 kazi716 commented Jun 4, 2026

Copy link
Copy Markdown

Closes #1

Changes

  • Added shields.io badges (PHP, MySQL, Bootstrap, License, Status)
  • Added prominent Live Demo and Demo Video links at the top
  • Fixed typo: "Demo Vedio" → "Demo Video"
  • Added Folder Structure section explaining project layout
  • Added Contributing section with step-by-step guide
  • Added License and Author sections
  • Improved overall formatting and readability

Why

The README lacked badges, folder structure explanation, contributing
guidelines, and had a typo. This makes the project look more
professional and easier for new contributors to get started.

@vercel

vercel Bot commented Jun 4, 2026

Copy link
Copy Markdown

@kazi716 is attempting to deploy a commit to the amitpaul2004's projects Team on Vercel.

A member of the Team first needs to authorize 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.

create readme.md file for this project

1 participant