Skip to content

Commit 9296cfe

Browse files
committed
docs: update README to reflect current repo structure
1 parent 635ce85 commit 9296cfe

File tree

1 file changed

+20
-21
lines changed

1 file changed

+20
-21
lines changed
Lines changed: 20 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,40 @@
11
# proposal-writer
22

3-
Technical proposal generation agent with ROI calculation, three-tier pricing, and business-value framing. Uses a Problem-Agitate-Solve narrative structure with optional PDF export for client-ready deliverables.
4-
5-
---
3+
Technical proposal generation agent that combines ROI modeling, calibrated estimates, and three-tier pricing into structured, client-ready documents. Turns project scope into a persuasive proposal that quantifies business value before asking for investment.
64

75
## Run
86

97
```bash
108
npx @open-gitagent/gitagent run -r https://github.com/Mathews-Tom/proposal-writer
119
```
1210

13-
---
14-
1511
## What It Can Do
1612

17-
- **ROI Calculation** — Quantify return on investment with cost-benefit analysis and payback period estimation
18-
- **Three-Tier Pricing** — Generate good/better/best pricing structures with feature differentiation
19-
- **Problem-Agitate-Solve Narrative** — Structure proposals using PAS framework for maximum persuasion
20-
- **Business-Value Framing** — Translate technical capabilities into business outcomes and executive language
21-
- **PDF Export** — Produce formatted, client-ready PDF documents
22-
- **Competitive Positioning** — Differentiate offerings against alternatives with evidence-based comparisons
23-
24-
---
13+
- **ROI Modeling** — calculates cost savings, efficiency gains, revenue impact, payback period, and 3-year projections with specific figures
14+
- **Three-Tier Pricing** — structures Essential/Professional/Enterprise options so the client self-selects rather than facing a binary decision
15+
- **Problem-Agitate-Solve Framing** — leads with the business challenge, quantifies cost of inaction, then presents the solution
16+
- **Scope Definition** — explicitly lists inclusions, exclusions, and optional add-ons to prevent downstream disputes
17+
- **PDF Export** — produces professionally formatted proposal documents with cover page, TOC, and page numbers
2518

2619
## Structure
2720

2821
```
2922
proposal-writer/
30-
├── agent.yaml
31-
├── SOUL.md
32-
├── RULES.md
23+
├── .gitignore
3324
├── LICENSE
34-
├── icon.png
35-
└── banner.png
25+
├── README.md
26+
├── RULES.md
27+
├── SOUL.md
28+
├── agent.yaml
29+
├── assets/
30+
│ ├── icon.png
31+
│ └── banner.png
32+
└── knowledge/
33+
├── pricing-tier-framework.md
34+
├── proposal-structure.md
35+
└── roi-modeling.md
3636
```
3737

38-
---
39-
4038
## Built with
41-
[gitagent](https://github.com/open-gitagent/gitagent) — a git-native, framework-agnostic open standard for AI agents.
39+
40+
Built for the [gitagent](https://gitagent.sh) ecosystem.

0 commit comments

Comments
 (0)