docs: remove images and Homebrew references, fix GitHub URLs

- Remove .github/*.png images (not needed)
- Remove Homebrew installation instructions (no cask available)
- Fix original project URL to point to openai/codex
- Fix GitHub URLs from valknar to valknarthing

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
Sebastian Krüger
2025-11-13 09:50:21 +01:00
parent 5a9de8e195
commit 4ddd4e078f
4 changed files with 5 additions and 17 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 2.9 MiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 408 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.1 MiB

View File

@@ -1,13 +1,9 @@
<p align="center"><code>npm i -g @valknarthing/llmx</code><br />or <code>brew install --cask llmx</code></p> <p align="center"><code>npm i -g @valknarthing/llmx</code></p>
<p align="center"><strong>LLMX CLI</strong> is a coding agent powered by LiteLLM that runs locally on your computer. <p align="center"><strong>LLMX CLI</strong> is a coding agent powered by LiteLLM that runs locally on your computer.
</br> </br>
</br>This project is a community fork with enhanced support for multiple LLM providers via LiteLLM. </br>This project is a community fork with enhanced support for multiple LLM providers via LiteLLM.
</br>Original project: <a href="https://github.com/openai/llmx">github.com/openai/llmx</a></p> </br>Original project: <a href="https://github.com/openai/codex">github.com/openai/codex</a></p>
<p align="center">
<img src="./.github/llmx-cli-splash.png" alt="LLMX CLI splash" width="80%" />
</p>
--- ---
@@ -15,28 +11,20 @@
### Installing and running LLMX CLI ### Installing and running LLMX CLI
Install globally with your preferred package manager. If you use npm: Install globally with npm:
```shell ```shell
npm install -g @valknarthing/llmx npm install -g @valknarthing/llmx
``` ```
Alternatively, if you use Homebrew:
```shell
brew install --cask llmx
```
Then simply run `llmx` to get started: Then simply run `llmx` to get started:
```shell ```shell
llmx llmx
``` ```
If you're running into upgrade issues with Homebrew, see the [FAQ entry on brew upgrade llmx](./docs/faq.md#brew-upgrade-llmx-isnt-upgrading-me).
<details> <details>
<summary>You can also go to the <a href="https://github.com/valknar/llmx/releases/latest">latest GitHub Release</a> and download the appropriate binary for your platform.</summary> <summary>You can also go to the <a href="https://github.com/valknarthing/llmx/releases/latest">latest GitHub Release</a> and download the appropriate binary for your platform.</summary>
Each GitHub Release contains many executables, but in practice, you likely want one of these: Each GitHub Release contains many executables, but in practice, you likely want one of these:
@@ -96,7 +84,7 @@ LLMX CLI supports a rich set of configuration options, with preferences stored i
- [Auth methods](./docs/authentication.md#forcing-a-specific-auth-method-advanced) - [Auth methods](./docs/authentication.md#forcing-a-specific-auth-method-advanced)
- [Login on a "Headless" machine](./docs/authentication.md#connecting-on-a-headless-machine) - [Login on a "Headless" machine](./docs/authentication.md#connecting-on-a-headless-machine)
- **Automating LLMX** - **Automating LLMX**
- [GitHub Action](https://github.com/valknar/llmx-action) - [GitHub Action](https://github.com/valknarthing/llmx-action)
- [TypeScript SDK](./sdk/typescript/README.md) - [TypeScript SDK](./sdk/typescript/README.md)
- [Non-interactive mode (`llmx exec`)](./docs/exec.md) - [Non-interactive mode (`llmx exec`)](./docs/exec.md)
- [**Advanced**](./docs/advanced.md) - [**Advanced**](./docs/advanced.md)