Skip to content

Commit cfb9d88

Browse files
committed
docs(readme): restore roles
1 parent ecc77ed commit cfb9d88

1 file changed

Lines changed: 28 additions & 25 deletions

File tree

README.md

Lines changed: 28 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -50,12 +50,15 @@ It's lightweight (25MB app size) and uses ~100MB of RAM and <1% cpu.
5050

5151
## Why Dayflow
5252

53-
Most time trackers only log app usage. Dayflow understands context the difference between "researching on YouTube" and "watching cat videos" so your timeline reflects real work, not just which window was open.
53+
Most time trackers only log app usage. Dayflow understands context - the difference between "researching on YouTube" and "watching cat videos" - so your timeline reflects real work, not just which window was open.
5454

5555
It's fully open‑source and extensible: inspect the codebase, audit how data is handled, and build it yourself for maximum security.
5656

5757
## How people get value
5858

59+
- **Founders:** See where days disappear, balance maker vs. manager time, and spot hidden context switching.
60+
- **Engineers:** Verify what really shipped, generate a standup recap in minutes, and reduce interruption drag.
61+
- **Students:** Make study sessions visible, reduce distraction drift, and build better routines.
5962
- **AI researchers:** See where time actually went across experiments vs. reading vs. coding, and tighten your research loop.
6063
- **Marketing:** Track time by campaign/channel, protect creative blocks, and cut hidden ops overhead.
6164
- **Sales:** Make calls, follow‑ups, and CRM time visible; prep pipeline recaps fast.
@@ -67,13 +70,13 @@ It's fully open‑source and extensible: inspect the codebase, audit how data is
6770
## Features
6871

6972
- **Automatic timeline** of your day with concise summaries.
70-
- **Context‑aware tracking** more than app usage; understands what you were doing.
71-
- **Extraordinarily battery‑efficient** by design stays out of your way.
73+
- **Context‑aware tracking** - more than app usage; understands what you were doing.
74+
- **Extraordinarily battery‑efficient** by design - stays out of your way.
7275
- **Watch timelapses of your day**.
7376
- **Distraction highlights** to see what pulled you off‑task.
74-
- **Timeline export** export your timeline as Markdown for any date range.
75-
- **Local‑first privacy** data stays on your Mac; choose your AI provider.
76-
- **Open‑source & extensible** inspect the codebase or build it yourself.
77+
- **Timeline export** - export your timeline as Markdown for any date range.
78+
- **Local‑first privacy** - data stays on your Mac; choose your AI provider.
79+
- **Open‑source & extensible** - inspect the codebase or build it yourself.
7780
- **Native UX** built with **SwiftUI**.
7881
- **Automatic storage cleanup** with configurable limits.
7982

@@ -85,29 +88,29 @@ Set intentions, reflect on your day, and get AI-generated summaries of your acti
8588
<img src="docs/images/JournalPreview.png" alt="Dayflow journal preview" width="800">
8689
</div>
8790

88-
- **Morning intentions** plan what you want to accomplish.
89-
- **Evening reflections** review how your day actually went.
90-
- **AI summaries** get auto-generated insights from your timeline.
91-
- **Scheduled reminders** configurable notifications for intentions and reflections.
92-
- **Weekly view** see patterns across your week.
91+
- **Morning intentions** - plan what you want to accomplish.
92+
- **Evening reflections** - review how your day actually went.
93+
- **AI summaries** - get auto-generated insights from your timeline.
94+
- **Scheduled reminders** - configurable notifications for intentions and reflections.
95+
- **Weekly view** - see patterns across your week.
9396

9497
> **Note:** Journal is currently in beta with limited access. Enter your access code in the app to unlock it.
9598
9699
### Coming soon
97100

98-
- **Dashboard (beta ChatGPT/Claude only)** ask any question about your workday, pipe the answers into tiles you arrange yourself, and track trends over time.
101+
- **Dashboard (beta - ChatGPT/Claude only)** - ask any question about your workday, pipe the answers into tiles you arrange yourself, and track trends over time.
99102

100103
<div align="center">
101104
<img src="docs/images/DashboardPreview.png" alt="Dayflow dashboard preview" width="800">
102105
</div>
103106

104107
## How it works
105108

106-
1) **Capture** Watches your screen in lightweight chunks.
107-
2) **Analyze** Periodically sends recent activity to your chosen AI provider.
108-
3) **Generate** AI creates timeline cards with activity summaries.
109-
4) **Display** Shows your day as a visual timeline.
110-
5) **Cleanup** Auto-manages storage based on your configured limits (1GB–20GB or unlimited).
109+
1) **Capture** - Watches your screen in lightweight chunks.
110+
2) **Analyze** - Periodically sends recent activity to your chosen AI provider.
111+
3) **Generate** - AI creates timeline cards with activity summaries.
112+
4) **Display** - Shows your day as a visual timeline.
113+
5) **Cleanup** - Auto-manages storage based on your configured limits (1GB–20GB or unlimited).
111114

112115
### AI Processing Pipeline
113116

@@ -150,7 +153,7 @@ flowchart LR
150153
class GD,LD2,CD result
151154
```
152155

153-
**Gemini** leverages native video understanding for direct analysis. **Local models** reconstruct understanding from individual frame descriptions. **ChatGPT/Claude** uses CLI tools to batch-process extracted frames with frontier reasoning modelsbalancing quality and efficiency.
156+
**Gemini** leverages native video understanding for direct analysis. **Local models** reconstruct understanding from individual frame descriptions. **ChatGPT/Claude** uses CLI tools to batch-process extracted frames with frontier reasoning models - balancing quality and efficiency.
154157

155158

156159
---
@@ -225,12 +228,12 @@ All Dayflow data is stored in:
225228
- **Purge / reset tip:** Quit Dayflow. Then delete the entire `Dayflow/` folder to remove recordings and analysis artifacts. Relaunch to start fresh.
226229

227230
### Processing modes & providers
228-
- **Gemini (cloud, BYO key)** Dayflow sends batch payloads to **Google's Gemini API** for analysis.
229-
- **Local models (Ollama / LM Studio)** Processing stays **on‑device**; Dayflow talks to a **local server** you run.
230-
- **ChatGPT / Claude (CLI-based, paid plan required)** Dayflow drives the **Codex CLI** (ChatGPT) or **Claude Code CLI** directly on your Mac. **Requires an active ChatGPT Plus/Pro or Claude Pro subscription.** Uses frontier reasoning models for best-in-class narrative quality.
231+
- **Gemini (cloud, BYO key)** - Dayflow sends batch payloads to **Google's Gemini API** for analysis.
232+
- **Local models (Ollama / LM Studio)** - Processing stays **on‑device**; Dayflow talks to a **local server** you run.
233+
- **ChatGPT / Claude (CLI-based, paid plan required)** - Dayflow drives the **Codex CLI** (ChatGPT) or **Claude Code CLI** directly on your Mac. **Requires an active ChatGPT Plus/Pro or Claude Pro subscription.** Uses frontier reasoning models for best-in-class narrative quality.
231234

232235
### TL;DR: Gemini data handling (my reading of Google’s ToS)
233-
- **Short answer: There is a way to prevent Google from training on your data.** If you **enable Cloud Billing** on **at least one** Gemini API project, Google treats **all of your Gemini API and Google AI Studio usage** under the **“Paid Services”** data‑use rules **even when you’re using unpaid/free quota**. Under Paid Services, **Google does not use your prompts/responses to improve Google products/models**.
236+
- **Short answer: There is a way to prevent Google from training on your data.** If you **enable Cloud Billing** on **at least one** Gemini API project, Google treats **all of your Gemini API and Google AI Studio usage** under the **“Paid Services”** data‑use rules - **even when you’re using unpaid/free quota**. Under Paid Services, **Google does not use your prompts/responses to improve Google products/models**.
234237
- Terms: “When you activate a Cloud Billing account, all use of Gemini API and Google AI Studio is a ‘Paid Service’ with respect to how Google Uses Your Data, even when using Services that are offered free of charge.” ([Gemini API Additional Terms](https://ai.google.dev/gemini-api/terms#paid-services-how-google-uses-your-data))
235238
- Abuse monitoring: even under Paid Services, Google **logs prompts/responses for a limited period** for **policy enforcement and legal compliance**. ([Same Terms](https://ai.google.dev/gemini-api/terms#paid-services-how-google-uses-your-data))
236239
- **EEA/UK/Switzerland:** the **Paid‑style data handling applies by default** to **all Services** (including AI Studio and unpaid quota) **even without billing**. ([Same Terms](https://ai.google.dev/gemini-api/terms#unpaid-services-how-google-uses-your-data))
@@ -283,8 +286,8 @@ Apple’s docs: https://support.apple.com/guide/mac-help/control-access-screen-s
283286
Dayflow registers a `dayflow://` URL scheme so you can trigger common actions from Shortcuts, hotkey launchers, or scripts.
284287

285288
**Supported URLs**
286-
- `dayflow://start-recording` enable capture (no-op if already recording)
287-
- `dayflow://stop-recording` pause capture (no-op if already paused)
289+
- `dayflow://start-recording` - enable capture (no-op if already recording)
290+
- `dayflow://stop-recording` - pause capture (no-op if already paused)
288291

289292
**Quick checks**
290293
- From Terminal: `open dayflow://start-recording` or `open dayflow://stop-recording`
@@ -321,7 +324,7 @@ Dayflow/
321324
## Roadmap
322325

323326
- [ ] V1 of the Dashboard (track answers to custom questions)
324-
- [x] V1 of the daily journal _now in beta!_
327+
- [x] V1 of the daily journal - _now in beta!_
325328
- [ ] Fine-tuning a small VLM for improved local model quality
326329

327330
---

0 commit comments

Comments
 (0)