Skip to content

Commit 9c3eef2

Browse files
committed
docs: Update README.md
1 parent acc2aaf commit 9c3eef2

5 files changed

Lines changed: 24 additions & 1 deletion

File tree

β€ŽREADME.mdβ€Ž

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,9 @@
1616
</p>
1717

1818
<p align="center">
19-
<img src="./docs/screenshot.png" alt="Screenshot" width="680">
19+
<img src="./screenshots/board.png" alt="Board" width="680">
20+
<img src="./screenshots/task.png" alt="Task" width="680">
21+
<img src="./screenshots/settings.png" alt="Settings" width="680">
2022
</p>
2123

2224
## Installation
@@ -25,6 +27,27 @@
2527
brew install --cask koki-develop/tap/cork
2628
```
2729

30+
## How it works
31+
32+
Cork has no database. A workspace is just a folder, and every task is a plain Markdown file inside it β€” so your board lives entirely in version-controllable, editor-friendly text.
33+
34+
- **One task = one `.md` file.** The file name is the task title; the Markdown body is the task description.
35+
- **Frontmatter holds the metadata.** `status`, `tags`, and `date` live in the YAML frontmatter at the top of each file.
36+
37+
```markdown
38+
---
39+
status: In Progress
40+
tags:
41+
- feature
42+
- urgent
43+
date: 2026-06-12
44+
---
45+
46+
Write the project README, including a "How it works" section.
47+
```
48+
49+
Because it's all just files, you can edit tasks in any editor, grep them, and track the whole board in Git.
50+
2851
## License
2952

3053
[MIT](./LICENSE)

β€Ždocs/screenshot.pngβ€Ž

-586 KB
Binary file not shown.

β€Žscreenshots/board.pngβ€Ž

904 KB
Loading

β€Žscreenshots/settings.pngβ€Ž

1.1 MB
Loading

β€Žscreenshots/task.pngβ€Ž

1020 KB
Loading

0 commit comments

Comments
Β (0)