ReadGit is a sleek and intuitive web application that allows developers to generate professional, personalized README.md
files for their GitHub repositories without logging in. Whether you're building a portfolio or documenting a project, ReadGit makes it easy with customizable sections, skill icons, animated GIFs, GitHub stats, and more.
🔗 Live Demo: ReadGit
- 🚫 No Login Required – Use instantly without authentication.
- 🎨 Live Markdown Preview – See your README as you build it.
- 🧠 Smart Section Builder – Add, edit, and remove sections like:
- About Me
- Skills & Tools
- GitHub Stats
- Social Links
- GIFs & Media
- 🛠️ Skill Icons Picker – Choose from a wide list of popular technologies (React, Node.js, Python, etc.).
- 📊 GitHub Stats Cards – Show off contributions, commits, and more.
- 🎞️ Animated GIF Embeds – Add personality or demo your projects.
- 🌗 Dark/Light Mode – Smooth toggle between themes.
- 📥 Export to Markdown – Download your custom
README.md
file or copy to clipboard.
To run the project locally:
git clone https://github.com/nishatkh/readgit.git
cd readgit
npm install
npm start