Initial commit
This commit is contained in:
109
skills/skill-creator/templates/README.md.j2
Normal file
109
skills/skill-creator/templates/README.md.j2
Normal file
@@ -0,0 +1,109 @@
|
||||
# {{ skill_title }}
|
||||
|
||||
{{ description }}
|
||||
|
||||
## Quick Start
|
||||
|
||||
```
|
||||
User: "{{ trigger_phrases[0] }}"
|
||||
```
|
||||
|
||||
Claude will:
|
||||
1. [Action 1]
|
||||
2. [Action 2]
|
||||
3. [Action 3]
|
||||
|
||||
## Features
|
||||
|
||||
### Feature 1: [Feature Name]
|
||||
- [Capability 1]
|
||||
- [Capability 2]
|
||||
- [Capability 3]
|
||||
|
||||
### Feature 2: [Feature Name]
|
||||
- [Capability 1]
|
||||
- [Capability 2]
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
/plugin install {{ skill_name }}@claudex
|
||||
```
|
||||
|
||||
Or manually:
|
||||
|
||||
```bash
|
||||
cp -r {{ skill_name }} ~/.claude/skills/
|
||||
```
|
||||
|
||||
## Usage Examples
|
||||
|
||||
### Example 1: [Scenario Name]
|
||||
|
||||
**Scenario:** [Description of scenario]
|
||||
|
||||
```
|
||||
User: "{{ trigger_phrases[0] }}"
|
||||
```
|
||||
|
||||
**Result:**
|
||||
- [Outcome 1]
|
||||
- [Outcome 2]
|
||||
|
||||
### Example 2: [Another Scenario]
|
||||
|
||||
**Scenario:** [Description of scenario]
|
||||
|
||||
```
|
||||
User: "{{ trigger_phrases[1] if trigger_phrases|length > 1 else trigger_phrases[0] }}"
|
||||
```
|
||||
|
||||
**Result:**
|
||||
- [Outcome 1]
|
||||
- [Outcome 2]
|
||||
|
||||
## Requirements
|
||||
|
||||
- [Requirement 1]
|
||||
- [Requirement 2]
|
||||
|
||||
## Configuration
|
||||
|
||||
{% if has_config %}
|
||||
[TODO: Describe configuration options]
|
||||
{% else %}
|
||||
No additional configuration required.
|
||||
{% endif %}
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Issue 1: [Issue Name]
|
||||
**Problem:** [Description]
|
||||
**Solution:** [Steps to resolve]
|
||||
|
||||
### Issue 2: [Issue Name]
|
||||
**Problem:** [Description]
|
||||
**Solution:** [Steps to resolve]
|
||||
|
||||
## Best Practices
|
||||
|
||||
- [Practice 1]
|
||||
- [Practice 2]
|
||||
- [Practice 3]
|
||||
|
||||
## Limitations
|
||||
|
||||
- [Limitation 1]
|
||||
- [Limitation 2]
|
||||
|
||||
## Contributing
|
||||
|
||||
See [CONTRIBUTING.md](https://github.com/cskiro/claudex/blob/main/CONTRIBUTING.md) for contribution guidelines.
|
||||
|
||||
## License
|
||||
|
||||
Apache 2.0
|
||||
|
||||
## Version History
|
||||
|
||||
See [CHANGELOG.md](./CHANGELOG.md) for version history.
|
||||
Reference in New Issue
Block a user