Update README with project/sprint CRUD documentation

This commit is contained in:
Max 2026-02-21 17:40:34 -06:00
parent 42188457da
commit 7d40459211

View File

@ -69,6 +69,18 @@ A unified CLI that covers all API operations.
```bash
# List all projects
./scripts/gantt.sh project list
# Create project
./scripts/gantt.sh project create "Project Name" "Description" "#color"
# Update project field
./scripts/gantt.sh project update <project-id> <field> <value>
./scripts/gantt.sh project update abc-123 name "New Name"
./scripts/gantt.sh project update abc-123 description "New desc"
./scripts/gantt.sh project update abc-123 color "#ff0000"
# Delete project
./scripts/gantt.sh project delete <project-id>
```
### Sprint Commands
@ -76,6 +88,18 @@ A unified CLI that covers all API operations.
```bash
# List all sprints
./scripts/gantt.sh sprint list
# Create sprint
./scripts/gantt.sh sprint create "Sprint 2" <project-id> "2026-02-23" "2026-03-01" "Sprint goal"
# Update sprint field
./scripts/gantt.sh sprint update <sprint-id> <field> <value>
./scripts/gantt.sh sprint update abc-123 name "New Sprint Name"
./scripts/gantt.sh sprint update abc-123 status active
./scripts/gantt.sh sprint update abc-123 startDate "2026-02-25"
# Delete sprint
./scripts/gantt.sh sprint delete <sprint-id>
```
### Auth Commands
@ -144,7 +168,13 @@ Displays text files in terminal, saves binary files to `/tmp/`.
| Add comment | ✅ | ✅ | ❌ |
| Attach file | ✅ | ✅ | ✅ |
| List projects | ✅ | ✅ | ❌ |
| Create project | ✅ | ✅ | ❌ |
| Update project | ✅ | ✅ | ❌ |
| Delete project | ✅ | ✅ | ❌ |
| List sprints | ✅ | ✅ | ❌ |
| Create sprint | ✅ | ✅ | ❌ |
| Update sprint | ✅ | ✅ | ❌ |
| Delete sprint | ✅ | ✅ | ❌ |
| Auth login | ✅ | ✅ | ❌ |
| Auth logout | ✅ | ✅ | ❌ |
| Auth register | ✅ | ✅ | ❌ |