Skip to content

Commit bb5d617

Browse files
authored
Update README.md
1 parent 22a420c commit bb5d617

File tree

1 file changed

+3
-25
lines changed

1 file changed

+3
-25
lines changed

README.md

Lines changed: 3 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,7 @@
22

33
Task management plugin where each task lives as a separate note with YAML frontmatter. Features calendar integration, Kanban boards, time tracking, and Pomodoro timer.
44

5-
![Downloads](https://img.shields.io/github/downloads/callumalpass/tasknotes/main.js)
6-
![Screenshot of TaskNotes plugin](https://github.com/callumalpass/tasknotes/blob/main/media/175266750_comp.gif)
5+
<img src="https://github.com/user-attachments/assets/4f68646e-e3cb-4d0c-86cd-c1574a97fba0" />
76

87
**[📖 Documentation](https://callumalpass.github.io/tasknotes/)**
98

@@ -21,6 +20,8 @@ The frontmatter is extensible—add custom fields like "assigned-to" or "attachm
2120

2221
Each task being a full note means you can write descriptions, jot down thoughts as you work, and connect tasks to other notes through Obsidian's linking and graph features. Bases integration provides custom views on your task data.
2322

23+
![Screenshot of TaskNotes plugin](https://github.com/callumalpass/tasknotes/blob/main/media/175266750_comp.gif)
24+
2425
## Core Features
2526

2627
### Task Management
@@ -116,29 +117,6 @@ complete_instances: ["2024-01-08"]
116117
117118
TaskNotes includes an optional HTTP API server for external integrations. This enables creating tasks from browsers, automation tools, mobile apps, and custom scripts.
118119
119-
### Quick Start
120-
121-
1. Enable the HTTP API in Settings → HTTP API tab (desktop only)
122-
2. Configure port (default: 8080) and optional auth token
123-
3. Restart Obsidian to start the server
124-
125-
### Basic Usage
126-
```bash
127-
# Health check
128-
curl http://localhost:8080/api/health
129-
130-
# List all tasks
131-
curl http://localhost:8080/api/tasks
132-
133-
# Create a task
134-
curl -X POST http://localhost:8080/api/tasks \
135-
-H "Content-Type: application/json" \
136-
-d '{"title": "New task", "priority": "High"}'
137-
138-
# Get task statistics
139-
curl http://localhost:8080/api/stats
140-
```
141-
142120
### Browser Integration
143121
144122
The API enables browser integrations:

0 commit comments

Comments
 (0)