update readme#36
Merged
Merged
Conversation
Signed-off-by: JaredforReal <w13431838023@gmail.com>
There was a problem hiding this comment.
Pull request overview
This PR refreshes the top-level README to reposition Loom as a proactive multi-source inbox/triage system and to better reflect newer repo capabilities like arXiv support, the SPA frontend, and settings APIs.
Changes:
- Rewrites the introduction, feature list, and architecture/data-flow sections with more product-oriented messaging.
- Replaces the old Quick Start / CLI / API docs with updated command tables and setup examples.
- Updates project structure and adaptor documentation to mention newer modules such as
api_server.py, the frontend app, and the arXiv adaptor.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| # Configure a GitHub source | ||
| export GITHUB_TOKEN="ghp_xxxxxxxxxxxx" | ||
| loom source add github --repo owner/repo --events issues,pull_requests | ||
|
|
| ```bash | ||
| # Install | ||
| pip install -e . | ||
|
|
| 4. **Process** — The agent session executes the assigned prompt template and produces a result. | ||
| 5. **Review** — The result surfaces in the Web UI or CLI. The user can approve or dismiss. | ||
| 6. **Act** — On approval, Loom executes the action through the originating adaptor. | ||
| 6. **Action** — On approval, Loom executes the action through the originating adaptor. |
| | `loom down` | Stop daemon | | ||
| | `loom inbox` | List envelopes (Rich table) | | ||
| | `loom show <id>` | Envelope detail view | | ||
| | `loom approve <id>` | Approve proposed action | |
| | GET | `/api/status` | Daemon status | | ||
| | GET | `/api/envelopes` | List envelopes (filter by source, group, prefix) | | ||
| | GET | `/api/envelopes/{id}` | Get envelope detail | | ||
| | POST | `/api/envelopes/{id}/approve` | Approve proposed action | |
| ├── cli/ # CLI entry point | ||
| │ ├── main.py # argparse parser + command handlers | ||
| │ └── view/ # Rich rendering (tables, themes, doctor) | ||
| │ └── main.py # argparse parser + Rich rendering |
| cd loom/webui/src | ||
| npm run dev # Vite on :5173, proxies /api → :8732 | ||
| ``` | ||
| Features: `since` cursor, ETag conditional requests, rate limit backoff, per-repo polling, event type and label filtering, proxy support. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.