neon-readme

npm version License: MIT

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


🚀 How to Use

npx neon-readme

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

  1. Run the CLI using one of the methods above.
  2. 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.
  3. 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.