diff --git a/README.md b/README.md index c9dd3f13425a00647b4c43e8b10c4bf06dab2e71..3aa4fef9c99797592b5734a13da1cde6ab44ac4a 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,22 @@ few simple CLI invocations. Maybe connecting arbitrary data sources warrants a whole protocol like MCP, but I don't think something as basic as this does. Just some thoughtful design and prompting. +## Usage + +This section is first to entice you with _nasin pali_'s simplicity; after +installing the binary and prompt, having your coding tool using a better +planning system just requires typing six (or fewer!) characters. + +- When asking the model to do something a bit more complex, just append the + phrase `use np` + - If you want the model to `use np` _all_ the time, adjust the prompt after + pasting to say something like _always use `np` instead of any other todo + tools_. +- Once implemented, the `monitor` subcommand will show the model's plan and its + realtime progress and the `export` subcommand will export the rendered plan + and event log as Markdown. Should the model mark tasks failed/cancelled or + change the goal/task content, it's required to provide a reason. + ## Installation You need both the binary and the prompt.