Stats
Actions
Tags
From acc
Generates README.md templates for PHP projects with badges, Composer installation, PHP quick start examples, features, requirements, contributing, and license sections.
How this skill is triggered — by the user, by Claude, or both
Slash command
/acc:readme-templateThe summary Claude sees in its skill listing — used to decide when to auto-load this skill
Generate professional README.md files for PHP projects.
Generate professional README.md files for PHP projects.
# {Project Name}
{badges}
{one-line description}
## Features
{feature list with benefits}
## Requirements
{dependencies and versions}
## Installation
{composer command and setup steps}
## Quick Start
{minimal working example}
## Documentation
{links to detailed docs}
## Contributing
{link to CONTRIBUTING.md}
## Changelog
{link to CHANGELOG.md}
## License
{license type and link}
[](https://github.com/{owner}/{repo}/actions)
[](https://codecov.io/gh/{owner}/{repo})
[](https://packagist.org/packages/{vendor}/{package})
[](https://packagist.org/packages/{vendor}/{package})
[](LICENSE)
[](https://github.com/{owner}/{repo}/actions)
[](https://packagist.org/packages/{vendor}/{package})
## Features
- ✅ **Feature Name** — Brief description of benefit
- ✅ **Feature Name** — Brief description of benefit
- ✅ **Feature Name** — Brief description of benefit
- 🚧 **Coming Soon** — Planned feature
## Requirements
- PHP 8.4+
- Composer 2.0+
- Extensions: ext-json, ext-pdo
### Optional
- Redis (for caching)
- RabbitMQ (for queuing)
## Installation
```bash
composer require {vendor}/{package}
### Installation Section (With Config)
```markdown
## Installation
1. Install via Composer:
```bash
composer require {vendor}/{package}
php artisan vendor:publish --provider="Vendor\Package\ServiceProvider"
# .env
PACKAGE_API_KEY=your-key
PACKAGE_DEBUG=false
### Quick Start Section
```markdown
## Quick Start
```php
<?php
declare(strict_types=1);
use {Vendor}\{Package}\{MainClass};
// Initialize
${instance} = new {MainClass}();
// Basic operation
$result = ${instance}->doSomething('input');
// Output
echo $result->status; // "success"
### Documentation Section
```markdown
## Documentation
- 📖 [Getting Started](docs/getting-started.md)
- ⚙️ [Configuration](docs/configuration.md)
- 📚 [API Reference](docs/api/README.md)
- 💡 [Examples](docs/examples/)
- ❓ [FAQ](docs/faq.md)
## Contributing
Contributions are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for:
- Development setup
- Coding standards
- Testing guidelines
- Pull request process
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
# Awesome Package
[](https://github.com/vendor/awesome-package/actions)
[](https://codecov.io/gh/vendor/awesome-package)
[](https://packagist.org/packages/vendor/awesome-package)
[](https://packagist.org/packages/vendor/awesome-package)
[](LICENSE)
A PHP library for processing awesome things with type safety and modern practices.
## Features
- ✅ **Type-Safe API** — Full PHP 8.4 type declarations
- ✅ **PSR Compliant** — PSR-4, PSR-7, PSR-12
- ✅ **Zero Dependencies** — No external runtime dependencies
- ✅ **Fully Tested** — 100% code coverage
## Requirements
- PHP 8.4+
- Composer 2.0+
- ext-json
## Installation
```bash
composer require vendor/awesome-package
<?php
declare(strict_types=1);
use Vendor\AwesomePackage\Processor;
$processor = new Processor();
$result = $processor->process(['data' => 'value']);
echo $result->status; // "success"
See CONTRIBUTING.md for development setup and guidelines.
See CHANGELOG.md for version history.
MIT License - see LICENSE for details.
## Generation Instructions
When generating a README:
1. **Analyze** the project structure (`composer.json`, `src/`)
2. **Identify** main class/entry point
3. **Extract** dependencies and requirements
4. **Create** minimal working example
5. **Generate** appropriate badges
6. **Link** to existing documentation
7. **Verify** all links point to existing files
npx claudepluginhub dykyi-roman/awesome-claude-code --plugin accGenerates professional README.md for projects by scanning manifests like package.json/pyproject.toml, interviewing on type/language/depth/license, adding badges/sections.
Checks and configures README.md with logos, badges, features, tech stack, and project structure. Detects metadata from package.json, pyproject.toml, Cargo.toml, go.mod for JS/TS, Python, Rust, Go projects.
Generates professional README.md by analyzing project files like package.json, pyproject.toml, go.mod, directory structure, and CLAUDE.md. Use when writing or supplementing project docs.