From 0940dbdff4ff2bb5b161d3e49e527b1a8ef70d75 Mon Sep 17 00:00:00 2001
From: Zhang Chengdong <jambecome@gmail.com>
Date: Sat, 27 Jun 2026 13:40:51 +0800
Subject: [PATCH] docs: add initial README with project structure and skill
 authoring guide

---
 README.md | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 54 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e7357b4
--- /dev/null
+++ b/README.md
@@ -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)