Skip to content

Commit 3fbac08

Browse files
committed
Simplify README install flow
1 parent a598de4 commit 3fbac08

1 file changed

Lines changed: 22 additions & 38 deletions

File tree

README.md

Lines changed: 22 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -15,40 +15,27 @@
1515

1616
Paperclip Aperture treats Paperclip as the host runtime and UI shell, while importing [Aperture Core](https://github.com/tomismeta/aperture/tree/main/packages/core) via the npm package [`@tomismeta/aperture-core`](https://www.npmjs.com/package/@tomismeta/aperture-core).
1717

18-
It turns Paperclip approvals, issue activity, and other operator-facing events into an Aperture-style attention surface:
18+
It turns Paperclip approvals, issue activity, and other operator-facing events into a Focus surface that ranks what deserves attention now, next, and ambient.
1919

20-
```text
21-
+------------------+ +-------------------+ +-------------------+ +------------------+ +------------------+
22-
| Paperclip events | --> | Plugin translates | --> | Aperture judges | --> | Paperclip renders| --> | Human responds |
23-
| approvals | | explicit facts | | now / next / | | attention UI | | into host action |
24-
| issues | | from host payloads| | ambient | | + operator tools | | approve / reject |
25-
| run failures | | | | | | | | acknowledge |
26-
+------------------+ +-------------------+ +-------------------+ +------------------+ +------------------+
27-
```
28-
29-
Links:
30-
31-
- Aperture core on npm: [`@tomismeta/aperture-core`](https://www.npmjs.com/package/@tomismeta/aperture-core)
32-
- Aperture GitHub repo: [tomismeta/aperture](https://github.com/tomismeta/aperture)
33-
- Paperclip GitHub repo: [paperclipai/paperclip](https://github.com/paperclipai/paperclip)
20+
## Install
3421

35-
## Start Here
36-
37-
Choose one path:
38-
39-
- **install the plugin locally** if you want to run it in Paperclip today
40-
- **run the demo** if you want a short live walkthrough
41-
- **read the architecture** if you want to understand how Aperture is embedded inside the plugin
22+
This plugin is not yet published to npm.
4223

43-
### Run The Demo
24+
Today, the supported path is a local-path install into a running Paperclip instance.
4425

45-
Use the live demo guide in [docs/DEMO.md](./docs/DEMO.md).
26+
If Paperclip is already running, the shortest path is:
4627

47-
### Install The Plugin Locally
28+
```bash
29+
git clone git@github.com:tomismeta/paperclip-aperture.git
30+
cd paperclip-aperture
31+
pnpm install
32+
pnpm build
4833

49-
This plugin is not yet published to npm.
34+
cd /path/to/paperclip
35+
pnpm paperclipai plugin install /absolute/path/to/paperclip-aperture
36+
```
5037

51-
Today, the supported path is a local-path plugin install into a Paperclip instance:
38+
If you need to start Paperclip first:
5239

5340
```bash
5441
git clone git@github.com:tomismeta/paperclip-aperture.git
@@ -82,22 +69,12 @@ Then open Paperclip and navigate to:
8269
- `Settings -> Plugins -> Paperclip Aperture`
8370
- `/<company-prefix>/aperture`
8471

85-
Future install shape once this plugin is published:
72+
Once this plugin is published to npm, the install shape becomes:
8673

8774
```bash
8875
pnpm paperclipai plugin install @tomismeta/paperclip-aperture
8976
```
9077

91-
### Understand The Embedding Model
92-
93-
The architecture is host-first:
94-
95-
- host/runtime: Paperclip
96-
- judgment engine: Aperture
97-
- plugin artifact: `@tomismeta/paperclip-aperture`
98-
99-
The goal is to prove that Aperture can live inside Paperclip as a normal plugin, without changing Aperture core.
100-
10178
## What This Plugin Is
10279

10380
Paperclip Aperture is an alternative operator attention surface for Paperclip.
@@ -199,6 +176,13 @@ pnpm test
199176

200177
This repo uses the published Paperclip SDK packages directly and is being prepared for npm distribution as a normal installable plugin artifact.
201178

179+
## Links
180+
181+
- Aperture core on npm: [`@tomismeta/aperture-core`](https://www.npmjs.com/package/@tomismeta/aperture-core)
182+
- Aperture GitHub repo: [tomismeta/aperture](https://github.com/tomismeta/aperture)
183+
- Paperclip GitHub repo: [paperclipai/paperclip](https://github.com/paperclipai/paperclip)
184+
- Demo guide: [docs/DEMO.md](./docs/DEMO.md)
185+
202186
## Status
203187

204188
This is a working integration prototype.

0 commit comments

Comments
 (0)