name: github-readme-skill
description: Generate a clean and professional GitHub README for AI, crypto, Web3, and open-source projects.
category: documentation
version: 1.0.0
author: Codex Hermes
--------------------

# GitHub README Skill

Use this skill when the user wants to create or improve a GitHub README for a project.

## Required Inputs

* Project name
* Project description
* Website URL
* Tech stack
* Features
* Installation steps, if available
* Usage instructions, if available
* License, if available

## Process

1. Understand the project purpose.
2. Create a clear README structure.
3. Explain the project in simple language.
4. Include setup and usage sections when details are provided.
5. Add environment variable examples only with placeholder values.
6. Avoid exposing real API keys, tokens, or private credentials.
7. Keep the README suitable for GitHub.

## Output Format

Return:

1. Project title
2. Short description
3. Features
4. Tech stack
5. Installation
6. Environment variables example
7. Usage
8. Roadmap
9. Security notes
10. License section

## Security Rules

* Never include real secrets.
* Never ask the user to paste private keys.
* Use placeholder values for API keys.
* Add a warning to keep .env files out of GitHub.