From 6bcef28dbe07c9e1630e5bf736e5722df6fc14cf Mon Sep 17 00:00:00 2001 From: Amolith Date: Tue, 26 Aug 2025 10:37:53 -0600 Subject: [PATCH] docs: mention installation from this fork --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index c040a2ce9bfd160588b0497ba28a3a4c1232c3a8..9b955dd87be5b10a3992b31d8b27c2ada9451242 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,24 @@ +**NOTE:** This is a Crush fork where I'm experimenting with prompts and other +things. I've also ripped out the CLA. Everything below the `Crush` heading is +from the original README. To install my fork, run… + +```sh +go install git.secluded.site/crush@dev +``` + +I pull upstream changes into the `upstream` branch here, break my branches off +that, then merge my changes into my `dev` branch, which gets rebased on +`upstream` fairly often. `dev` history will get rewritten frequently, so `go +install ... @dev` might not actually fetch the latest changes through the Go +module proxy. I'll try to make sure what the proxy has always compiles though. + +Contributions are welcome, no need for a CLA. I'll try to keep up with +maintaining anything I accept. + +Upstream is at: https://github.com/charmbracelet/crush + +--- + # Crush