diff --git a/README.md b/README.md index 8573ade18876480cab8256257766a7ce81ac76ec..2b7052eb8bbfc493425d434764391fb85701b8dc 100644 --- a/README.md +++ b/README.md @@ -9,15 +9,44 @@ SPDX-License-Identifier: CC0-1.0 [![REUSE status](https://api.reuse.software/badge/git.secluded.site/np)](https://api.reuse.software/info/git.secluded.site/np) [![Go Report Card](https://goreportcard.com/badge/git.secluded.site/np)](https://goreportcard.com/report/git.secluded.site/np) -**This README is aspirational!** None of the code exists yet, I'm just getting -my ideas down. I previously wrote a -[planning-mcp-server](https://git.secluded.site/planning-mcp-server) that I'll +The code for this README exists, but requires some testing before release. I +previously wrote a +[planning-mcp-server](https://git.secluded.site/planning-mcp-server) that I've keep some ideas from, and the overall workflow is about the same. I'm trying a CLI over MCP because MCP seems quite protocol-heavy for what _could_ just be a 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. +## Installation + +You need both the binary and the prompt. + +### The binary + +- Using [bin](https://github.com/marcosnils/bin) (highly recommended + because of centralised management/updates for statically-linked CLI tools like + this) + ```bash + bin install goinstall://git.secluded.site/np@latest + ``` +- Using the [go toolchain](https://go.dev/dl) (requires + tracking updates manually) + ```bash + go install git.secluded.site/np@latest + ``` + +### The prompt + +- Using `bin` + ```markdown + IMPORTANT: Instead of any built-in todo tools you may have available, stick with `np` unless I say otherwise. Try to use it, but if it's not in my PATH, ask me to install it by running `bin install goinstall://git.secluded.site/np@latest`. Start a session with `np s` and it'll guide you from there. + ``` +- Using `go install` + ```markdown + IMPORTANT: Instead of any built-in todo tools you may have available, stick with `np` unless I say otherwise. Try to use it, but if it's not in my PATH, ask me to install it by running `go install git.secluded.site/np@latest`. Start a session with `np s` and it'll guide you from there. + ``` + --- ## Overview