Initial commit

skills/plugin-builder/templates/README.md

@@ -0,0 +1,149 @@
+# Plugin Name
+
+Brief description of what this plugin does and why it's useful.
+
+## Installation
+
+### Via Marketplace
+
+```bash
+/plugin marketplace add <marketplace-url>
+/plugin install my-plugin@marketplace-name
+```
+
+### Direct Installation
+
+```bash
+/plugin install /path/to/my-plugin
+```
+
+Or from GitHub:
+
+```bash
+/plugin install https://github.com/username/my-plugin
+```
+
+## Components
+
+### Skills
+
+- **Skill Name**: Brief description of what the skill does
+- **Another Skill**: Brief description
+
+### Commands
+
+- `/my-command`: Description of what this command does
+- `/another-command`: Description of another command
+
+### Agents
+
+- **Agent Name**: Description of specialized agent behavior
+
+## Usage
+
+### Using Skills
+
+Skills are automatically discovered by Claude. Just mention tasks related to:
+- Key capability 1
+- Key capability 2
+- Key capability 3
+
+### Using Commands
+
+```bash
+# Example command usage
+/my-command param1 param2
+
+# Another example
+/another-command
+```
+
+### Example Workflows
+
+**Workflow 1: Common Task**
+1. Step 1
+2. Step 2
+3. Step 3
+
+**Workflow 2: Another Common Task**
+1. Step 1
+2. Step 2
+
+## Requirements
+
+- List any dependencies
+- Required environment variables
+- Minimum Claude Code version
+- System requirements
+
+## Configuration
+
+If your plugin needs configuration:
+
+```bash
+# Set environment variable
+export MY_PLUGIN_CONFIG=value
+```
+
+Or create a config file:
+
+```json
+{
+  "setting1": "value1",
+  "setting2": "value2"
+}
+```
+
+## Examples
+
+### Example 1: Basic Usage
+
+Detailed example showing basic functionality.
+
+```
+Step-by-step example
+```
+
+### Example 2: Advanced Usage
+
+More complex example showing advanced features.
+
+```
+Step-by-step example
+```
+
+## Troubleshooting
+
+**Problem: Common issue**
+- Solution: How to fix it
+
+**Problem: Another common issue**
+- Solution: How to fix it
+
+## Development
+
+To contribute or modify this plugin:
+
+```bash
+# Clone repository
+git clone https://github.com/username/my-plugin
+
+# Install locally
+/plugin install /path/to/my-plugin
+
+# Make changes
+# Test changes
+# Submit PR
+```
+
+## License
+
+MIT License - see LICENSE file for details
+
+## Author
+
+Your Name (your.email@example.com)
+
+## Changelog
+
+See [CHANGELOG.md](CHANGELOG.md) for version history.