Skip to content

Commit 0034ada

Browse files
committed
Enhance README with workflow, comparison, and interaction diagrams
1 parent d96a04e commit 0034ada

File tree

1 file changed

+67
-2
lines changed

1 file changed

+67
-2
lines changed

README.md

Lines changed: 67 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,20 @@ This repository contains three main tools:
1010
2. **`apply-md`** - Applies code changes from LLM's markdown response
1111
3. **`git-context`** - Generates git context for AI-assisted commit messages
1212

13+
## Workflow
14+
15+
Here's how poorcoder fits into your development workflow:
16+
17+
![poorcoder Workflow Diagram](./images/poorcoder-workflow-diagram.svg)
18+
1319
## Why poorcoder?
1420

15-
Unlike IDE-integrated solutions (Cursor, aider, Claude Code, etc.), poorcoder is designed to work with your existing web-based LLM subscriptions (~$20/month) while maintaining your terminal workflow. This approach:
21+
Unlike IDE-integrated solutions (Cursor, aider, Claude Code, etc.), poorcoder is designed to work with your existing web-based LLM subscriptions (~$20-30/month) while maintaining your terminal workflow.
22+
23+
![poorcoder vs. Other AI Coding Tools](./images/poorcoder-comparison-table.svg)
1624

17-
- Is more cost-effective than dedicated API usage
25+
Key benefits:
26+
- Is more cost-effective than dedicated API usage (which can cost $100-500/month for heavy use)
1827
- Leverages the polished UX of web/mobile LLM interfaces
1928
- Preserves your terminal-based development workflow
2029
- Follows Unix philosophy (small tools doing one thing well)
@@ -58,6 +67,10 @@ chmod +x autocommit
5867

5968
## Scripts
6069

70+
Here's a detailed overview of each script in poorcoder:
71+
72+
![poorcoder Script Details](./images/poorcoder-script-details.svg)
73+
6174
### 1. `context` - Code Context Generator
6275

6376
Extracts relevant code context from your project to send to a web-based LLM.
@@ -100,6 +113,58 @@ git commit -am "$(./git-context | llm -m openrouter/anthropic/claude-3.5-haiku)"
100113

101114
[See full documentation for git-context](./docs/git-context.md)
102115

116+
## Component Interaction
117+
118+
The following diagram shows how the different components of poorcoder interact with each other and with external systems:
119+
120+
```mermaid
121+
flowchart TB
122+
subgraph "Terminal Environment"
123+
context["context\n(Extract Code Context)"]
124+
applymd["apply-md\n(Apply Code Changes)"]
125+
gitcontext["git-context\n(Generate Git Info)"]
126+
clipboard[("Clipboard\n(pbcopy/pbpaste)")]
127+
files[("Project Files")]
128+
git[("Git Repository")]
129+
end
130+
131+
subgraph "Web Environment"
132+
llm["Web LLM\n(Claude.ai, Grok, etc.)"]
133+
end
134+
135+
subgraph "Optional CLI"
136+
llmcli["LLM CLI Tool\n(e.g., llm, sgpt)"]
137+
end
138+
139+
%% Connections for Web Workflow
140+
context -->|"Extract context"| files
141+
context -->|"Copy to clipboard"| clipboard
142+
clipboard -->|"Paste context"| llm
143+
llm -->|"Generate code"| clipboard
144+
clipboard -->|"Paste response"| applymd
145+
applymd -->|"Update files"| files
146+
147+
%% Connections for Git workflow
148+
gitcontext -->|"Extract changes"| git
149+
gitcontext -->|"Generate context"| llmcli
150+
llmcli -->|"Generate message"| git
151+
152+
%% Direct CLI workflow
153+
context -.->|"Direct pipe"| llmcli
154+
llmcli -.->|"Direct pipe"| applymd
155+
156+
%% Styling
157+
classDef tool fill:#4b6584,stroke:#333,stroke-width:1px,color:white
158+
classDef storage fill:#f5cd79,stroke:#333,stroke-width:1px
159+
classDef external fill:#6a89cc,stroke:#333,stroke-width:1px,color:white
160+
classDef cli fill:#78e08f,stroke:#333,stroke-width:1px
161+
162+
class context,applymd,gitcontext tool
163+
class files,clipboard,git storage
164+
class llm external
165+
class llmcli cli
166+
```
167+
103168
## Usage Workflows
104169

105170
### Dual Modality Approach

0 commit comments

Comments
 (0)