docs: add initial README with project structure and skill authoring guide
This commit is contained in:
54
README.md
Normal file
54
README.md
Normal file
@@ -0,0 +1,54 @@
|
||||
# Jamyun Skills
|
||||
|
||||
A collection of agent skills for reusable, modular capabilities.
|
||||
|
||||
Each skill lives in its own directory under `skills/` and contains a `SKILL.md` file with metadata, usage instructions, and implementation details.
|
||||
|
||||
## Structure
|
||||
|
||||
```
|
||||
skills/
|
||||
└── <skill-name>/
|
||||
└── SKILL.md
|
||||
```
|
||||
|
||||
## Example
|
||||
|
||||
```
|
||||
skills/
|
||||
└── final-answer/
|
||||
└── SKILL.md
|
||||
```
|
||||
|
||||
## Writing a Skill
|
||||
|
||||
A `SKILL.md` file should follow this format:
|
||||
|
||||
```markdown
|
||||
---
|
||||
name: skill-name
|
||||
description: Short description of what this skill does.
|
||||
---
|
||||
|
||||
# Skill Name
|
||||
|
||||
Longer description of the skill.
|
||||
|
||||
## Usage
|
||||
|
||||
When to use this skill and how to invoke it.
|
||||
|
||||
## Implementation
|
||||
|
||||
Details on how the skill works or how to extend it.
|
||||
```
|
||||
|
||||
## Adding a Skill
|
||||
|
||||
1. Create a new directory under `skills/<skill-name>/`.
|
||||
2. Add a `SKILL.md` file with the required frontmatter.
|
||||
3. Commit the change.
|
||||
|
||||
## License
|
||||
|
||||
[MIT](LICENSE)
|
||||
Reference in New Issue
Block a user