Skip to content

Commit 60efb02

Browse files
committed
add new readme
1 parent d92d226 commit 60efb02

1 file changed

Lines changed: 12 additions & 3 deletions

File tree

README.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ Simple CLI follow-up tracker.
99
- YAML import/export
1010
- simple workflow states: `created`, `waitme`, `waityou`, `finished`
1111
- activity log
12+
- optional `description` field on items
1213

1314
## Install
1415

@@ -26,24 +27,32 @@ pip install -e .
2627

2728
```bash
2829
trackr init
29-
trackr add devops-role "DevOps Engineer Budapest"
30+
trackr add devops-role "DevOps Engineer Budapest" --desc "OpenShift role with recruiter contact"
3031
trackr state devops-role waityou
3132
trackr note devops-role "CV sent"
3233
trackr set-review devops-role 2026-03-23
3334
trackr list
3435
trackr review
3536
trackr activity
37+
trackr history devops-role
3638
```
3739

3840
## YAML import format
3941

4042
```yaml
4143
items:
42-
- id: devops-role-saranya
44+
- id: devops-role-FixY
4345
title: DevOps Engineer - Budapest
46+
description: |
47+
OpenShift-heavy role.
48+
Recruiter: fix Y
4449
state: waityou
4550
next_review: 2026-03-23
4651
meta:
47-
recruiter: Saranya
52+
recruiter: fix Y
4853
source: linkedin
4954
```
55+
56+
## Extra
57+
58+
- `trackr history <item_id>` shows the event history for a single item.

0 commit comments

Comments
 (0)