🚀 AutoReadMe-CLI: Instantly Generate Professional README Files!
Let’s be honest—writing README files is one of the most tedious parts of starting a new project. You know it’s important, but let’s face it, no one enjoys doing it manually. That’s exactly why I built AutoReadMe-CLI—a simple, efficient, and interactive CLI tool that automates README generation in seconds!
With just one command, AutoReadMe extracts project metadata, formats it into a structured README.md file, and provides multiple templates to choose from. Whether you need a basic README, open-source guidelines, CLI tool documentation, or API reference, this package has you covered. You can even include GitHub badges and keep logs hidden to avoid unnecessary commits.
✨ Why Use AutoReadMe?
- ✔ Saves time – No more manually structuring README files
- ✔ Multiple templates – Basic, Open Source, CLI Tool, and API Docs
- ✔ Interactive CLI – Just answer a few prompts, and your README is ready
- ✔ GitHub Badges – Easily add relevant badges
- ✔ Auto Git Ignore – Prevents unnecessary logs from being committed
📌 How to Use?
1️⃣ Install globally:
npm install -g autoreadme-cli
2️⃣ Run inside any project folder:
autoreadme generate
🚀 Try it out today! If you find it useful, leave a ⭐ on GitHub and drop a review on npm! Feedback is always welcome—let me know what features you’d like to see next!
🔗 GitHub: AutoReadMe
🔗 NPM: autoreadme-cli
Top comments (0)