on main help sign in
docs(readme): add (temporary) installation instructions for non-developers
commit0e4f3326fa1d63afa61c15d62bb94dd69f024a17 authorChristian Rocha <christian@rocha.is> dateMon 21 Jul 2025, 14:02 (1 year ago) parentd525721
1 file changed+25−4
README.md+25−4
README.md+25−4
@@ -25,14 +25,35 @@ cd crush
2525go install
2626```
2727
28+<details>
29+<summary>Not a developer? Here’s a quick how-to.</summary>
30+
31+Download the latest [nightly release](https://github.com/charmbracelet/crush/releases) for your system. The [macOS ARM64](https://github.com/charmbracelet/crush/releases/download/nightly/crush_0.1.0-nightly_Darwin_arm64.tar.gz) is most likely what you want.
32+
33+Next, open a terminal and run the following commands:
34+
35+```bash
36+cd ~/Downloads
37+tar -xvzf crush_0.1.0-nightly_Darwin_arm64.tar.gz -C crush
38+sudo mv ./crush/crush /usr/local/bin/crush
39+rm -rf crush
40+```
41+
42+Then, run Crush by typing `crush`.
43+
44+***
45+
46+</details>
47+
2848Note that Crush doesn't support Windows yet, however Windows support is planned and in progress.
2949
3050## Getting Started
3151
32−For now, the quickest way to get started is to set an environment variable for
33−your preferred provider. Note that you can switch between providers mid-
34−sessions, so you're welcome to set environment variables for multiple
35−providers.
52+The quickest way to get started to grab an API key for your preferred
53+provider such as Anthropic, OpenAI, or Groq, and just start Crush. You'll be
54+prompted to enter your API key.
55+
56+That said, you can also set environment variables for preferred providers:
3657
3758| Environment Variable | Provider |
3859| -------------------------- | -------------------------------------------------- |