readme-not
v0.1.0
Published
Generate README files interactively
Maintainers
Readme
Interactive CLI tool to generate beautiful and professional README files for your projects.
✨ Features - Interactive prompts to collect project details
- Customizable templates for different project types
- Supports TypeScript and JavaScript projects
- Automatically generates README.md at project root
- Easy to install and use🛠️ Prerequisites Node.js (version 16 or higher) npm or pnpm
🔧 Installation bash npm install readme-not or bash pnpm add readme-not
🏃♂️ Usage bash npx readme-not or, if installed globally: bash readme-not Answer the interactive questions to generate your README!
📸 Example bash npx readme-not
? Project name: my-awesome-project
? Short description: A project to make the world a better place
...
A README.md file will be generated at your project root.🧩 Built With TypeScript Node.js inquirer (for interactive prompts)
🔗 Useful Links GitHub repository: github.com/yourusername/readme-not npm package: npmjs.com/package/readme-not
📝 License ISC
🤝 Contributing Contributions are welcome!
🚦 Versions Version Date Notes 0.1.0 2025-06-19 First release
💡 About A simple yet powerful tool to help developers create beautiful, standardized README files for their projects.
