Skip to content

Commit cb72918

Browse files
Add 'Getting started' section to README
Added a 'Getting started' section with installation and usage steps for the plugin.
1 parent 84feef5 commit cb72918

1 file changed

Lines changed: 11 additions & 3 deletions

File tree

README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,18 @@ After review, the agent can hand back to implementation mode by calling `plan_ex
2020

2121
Repository: <https://github.com/timrichardson/opencode-planner>
2222

23+
## Getting started
24+
1. Install plugin, launch opencode
25+
2. tab to Plan agent
26+
3. make a plan
27+
4. when the LLM considers the plan is complete, it will invoke your editor or PlanNotator will be invoked. PlanNotator has priority.
28+
5. add comments to the plan, save and exit the editor (you can also write "approved" although no edits should mean that as well)
29+
6. the Plan agent will react to chagnes you made, then you iterate. Or else, it says it is ready to implement. Exit Plan agent and tell the Build agent to implement.
30+
2331
## Commands added
24-
/edit-plan: open plan in editor as configured (this also happens automatically when opencode calls submit_plan tool)
25-
/plan-prompt: shows the plugin's prompt, as a starting point for customisation
26-
/planner-config: shows how it determines which editor is used because there are three possible env vars.
32+
* `/edit-plan`: open plan in editor as configured (this also happens automatically when opencode calls submit_plan tool)
33+
* `/plan-prompt`: shows the plugin's prompt, as a starting point for customisation
34+
* `/planner-config`: shows how it determines which editor is used because there are three possible env vars.
2735

2836

2937
### Rationale

0 commit comments

Comments
 (0)