Skip to content

Commit 1b899ba

Browse files
author
ComputelessComputer
committed
Refocus README on Openbird users
Move the product screenshot to the top of the README and rewrite the copy around user-facing value, privacy, setup, and product status.
1 parent 4e2e57e commit 1b899ba

1 file changed

Lines changed: 38 additions & 61 deletions

File tree

README.md

Lines changed: 38 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,36 @@
1-
# Openbird
2-
3-
Openbird is a local-first macOS activity journal.
4-
5-
It watches your current work context through the Accessibility API, stores that context on your Mac, and turns it into a daily review and follow-up chat.
6-
7-
> Disclaimer: Openbird is an experimental proof-of-concept app. The goal is to validate this local accessibility-first context layer before it is integrated into the [Char](https://char.com) codebase at [fastrepl/char](https://github.com/fastrepl/char).
8-
9-
It exists because software with this much visibility into your day should not be a black box.
10-
11-
No account is required. No backend is required.
12-
13-
## Why This Exists
1+
![Openbird Today view showing a generated daily review on macOS](./apps/landing/public/openbird-screenshot.png)
142

15-
If an app can see what you are doing across your computer, you should be able to inspect it, control it, pause it, and delete its data.
3+
# Openbird
164

17-
Openbird is built around a simple idea:
5+
Openbird is a local-first macOS app that keeps a private record of your workday, turns it into a daily review, and lets you ask questions about what you were doing.
186

19-
- your activity data should stay on your machine by default
20-
- your model should be your choice
21-
- the privacy boundary should be explicit
22-
- software this sensitive should be open source
7+
It is built for people who want help remembering their day without sending their activity history to someone else's server.
238

24-
This is not "trust us" software. The point is that you do not have to.
9+
No account. No backend. Your data stays on your Mac by default.
2510

26-
## What Openbird Does
11+
## What You Can Do With It
2712

28-
Openbird captures the frontmost app and window, builds a local timeline of your day, and uses that log to generate:
13+
Openbird builds a timeline from the app, window, tab, and on-screen context you are actively using, then uses that history to help you:
2914

30-
- a daily review with time blocks, highlights, and a short narrative
31-
- follow-up chat scoped to your local activity data
32-
- citations back to the underlying apps, windows, URLs, and timestamps
15+
- generate a daily review with time blocks, highlights, and a short narrative
16+
- ask follow-up questions about your day in chat
17+
- jump back to the apps, windows, URLs, and timestamps behind each summary
3318

34-
It is meant to answer questions like:
19+
It is useful for questions like:
3520

36-
- What did I do today?
37-
- What was I working on around 3pm?
38-
- Which project took most of my attention?
39-
- What tabs, apps, or docs was I using during that block?
21+
- What did I actually spend time on today?
22+
- What was I working on around 3 PM?
23+
- Which project got most of my attention?
24+
- Which apps, tabs, or docs was I using during that stretch?
4025

41-
## Privacy Boundary
26+
## Privacy, In Plain Terms
4227

43-
Openbird is intentionally conservative.
28+
Openbird is designed so you can see what it knows, control what it captures, and remove data whenever you want.
4429

4530
Openbird captures:
4631

4732
- the frontmost app
48-
- bundle ID and app name
33+
- app name and bundle ID
4934
- window title
5035
- browser tab URL when available
5136
- visible text from the active window's accessibility tree
@@ -65,22 +50,22 @@ You can also:
6550
- pause capture at any time
6651
- exclude apps
6752
- exclude domains
68-
- inspect the raw log used for generation
53+
- inspect the raw log behind each summary
6954
- delete the last hour, the last day, or everything
7055

7156
All captured data is stored locally in:
7257

7358
`~/Library/Application Support/Openbird/openbird.sqlite`
7459

75-
## Bring Your Own Model
60+
## Use Your Own Model
7661

77-
Openbird supports local-first BYOK out of the box.
62+
Openbird works with local and self-hosted model providers, including:
7863

7964
- Ollama
8065
- LM Studio
8166
- other OpenAI-compatible endpoints
8267

83-
You can run fully offline if your model is local.
68+
If your model runs locally, Openbird can stay fully offline.
8469

8570
Default local endpoints:
8671

@@ -100,36 +85,30 @@ Download the latest release here:
10085

10186
[Latest Release](https://github.com/ComputelessComputer/openbird/releases/latest)
10287

103-
New releases are shipped as a signed macOS Apple Silicon DMG.
104-
105-
If you are downloading an older tag, you may still see the previous unsigned tarball format.
106-
10788
Open the DMG, drag `Openbird.app` into `Applications`, then launch it.
10889

10990
## Quick Start
11091

111-
1. Download and extract the latest release.
112-
2. Launch `OpenbirdApp`.
92+
1. Download the latest release.
93+
2. Launch `Openbird.app`.
11394
3. Grant Accessibility permission when prompted.
114-
4. In Settings, choose an Ollama or LM Studio preset.
95+
4. In Settings, choose an Ollama or LM Studio preset, or add your own compatible endpoint.
11596
5. Click `Check Connection`, then save the provider.
116-
6. Go to `Today` and generate your first review.
97+
6. Open `Today` and generate your first review.
11798
7. Use `Chat` to ask questions about your day.
11899

119-
## What The App Looks Like
100+
## Inside The App
120101

121-
Openbird has four main surfaces:
102+
Openbird has four main areas:
122103

123-
- Onboarding: explains permissions and privacy
124-
- Today: generates the daily review
125-
- Chat: asks questions against your local activity log
126-
- Settings: provider setup, exclusions, retention, pause, and delete controls
104+
- Onboarding for permissions and privacy
105+
- Today for generating your daily review
106+
- Chat for asking questions about your activity history
107+
- Settings for model setup, exclusions, retention, pause, and delete controls
127108

128-
![Openbird Today view showing a generated daily review on macOS](./apps/landing/public/openbird-screenshot.png)
129-
130-
## Current State
109+
## Project Status
131110

132-
Openbird is early, but the core loop works:
111+
Openbird is still early and should be treated as experimental software, but the main flow already works:
133112

134113
- local capture
135114
- local storage
@@ -138,14 +117,12 @@ Openbird is early, but the core loop works:
138117
- daily journal generation
139118
- date-scoped chat over your activity history
140119

141-
The current scope is intentionally narrow. Openbird is focused on being a trustworthy personal activity journal first.
142-
143-
The longer-term direction is to bring this work into char.com without giving up the local-first and inspectable privacy model established here.
120+
The current focus is a trustworthy personal activity journal first. Parts of this work may later feed into [Char](https://char.com), but the goal here is to keep the local-first, inspectable privacy model intact.
144121

145122
## Open Source
146123

147-
Open source is not a branding choice here. It is part of the product.
124+
Open source is part of the product.
148125

149-
When software observes your work, transparency matters. You should be able to inspect how it captures data, where it stores it, what it excludes, and which model receives your prompts.
126+
When an app can observe your work, you should be able to inspect how it works, where it stores data, what it excludes, and which model receives your prompts.
150127

151-
The codebase is open because trust is better when it is verifiable.
128+
The code is public because trust is stronger when it can be verified.

0 commit comments

Comments
 (0)