neon-readme
v1.0.3
Published
Generate a premium, dark-neon-themed GitHub profile README in under a minute — with every widget checked against a currently-working endpoint, not just copy-pasted from stale docs.
Maintainers
Readme
neon-readme
Generate a premium, dark-neon-themed GitHub profile README in under a minute. The CLI validates widgets against working endpoints so badges and widgets don't break.
✨ Features
- Interactive CLI: Answer a few quick questions in your terminal to build a complete profile README.
- Dark Neon Themes: Built-in support for Tokyo Night, Radical, and Dracula aesthetics.
- Smart Tech Stack Badges: Integrates with skillicons.dev with automatic fallback to shields.io for any custom technologies.
- Dynamic Widgets: Includes dynamic header banners, rotating typing SVG, GitHub stats, top languages, streak stats, and activity graphs.
- Contribution Snake Animation: Generates a GitHub Actions workflow to render an animated contribution snake.
- Zero-Dependency Testing: Uses Node.js's native test runner (
node --test).
🚀 Quick Start
Run directly with npx (No installation needed)
npx neon-readmeOr run locally:
npm install
npm startFollow the prompts: Enter your name, GitHub username, role, focus areas, tech stack, theme, and optional projects/socials.
Publish your Profile README:
- The CLI will generate a
README.mdfile. - Push this
README.mdto a public repository namedusername/usernameon GitHub to display it on your profile.
- The CLI will generate a
🛠️ Development & Testing
Run the test suite:
npm test🤝 Contributing
Contributions are welcome! Check CONTRIBUTING.md for details.
📄 License
This project is licensed under the MIT License - see the LICENSE file for details.
