neon-readme

Generate a premium, dark-neon-themed GitHub profile README in under a minute. Uses curated dark-neon widgets with automatic shields.io badge fallbacks and URL validation.
✨ 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 and embeds a dark/light
<picture> snake animation block in your README.
- Zero-Dependency Testing: Uses Node.js’s native test runner (
node --test).
🚀 How to Use
Option 1: Run instantly with npx (Recommended — No Install Needed)
Option 2: Install Globally via npm
# Install globally
npm install -g neon-readme
# Run anytime from any directory
neon-readme
Option 3: Clone and Run Locally
# Clone the repository
git clone https://github.com/TejaPriyan/neon-readme.git
cd neon-readme
# Install dependencies and start
npm install
npm start
📋 Step-by-Step Workflow
- Run the CLI using one of the methods above.
- Follow the interactive prompts:
- Enter your Name, GitHub username, Role/Tagline, and Bio.
- Enter your current focus areas and tech stack.
- Pick a neon theme (
Tokyo Night, Radical, or Dracula).
- Optionally add social links (LinkedIn, Portfolio), featured projects, and the contribution snake workflow.
- Publish your Profile README:
- The CLI will generate a
README.md file (and optional .github/workflows/snake.yml).
- Push this
README.md to a public GitHub repository named username/username (e.g. TejaPriyan/TejaPriyan).
🛠️ Development & Testing
Run lint and tests locally:
npm install
npm run lint
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.