Skip to content

docs: add Installation section with Igniter instructions #439

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mikehostetler merged 3 commits into from
Feb 20, 2026
Merged

docs: add Installation section with Igniter instructions #439

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
419eb72
feat: add Igniter installer for automated package setup
Nickcom4 Feb 20, 2026
c141431
chore(ci): trigger CI for PR #439
mikehostetler Feb 20, 2026
a3f9626
docs(readme): align manual install version with current release
mikehostetler Feb 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,34 @@ LLM APIs are inconsistent. ReqLLM provides a unified, idiomatic Elixir interface

\* _Streaming uses Finch directly due to known Req limitations with SSE responses._

## Installation

### Igniter Installation (Recommended)

The fastest way to get started is with [Igniter](https://hex.pm/packages/igniter):

```bash
mix igniter.install req_llm
```

### Manual Installation

Add `req_llm` to your list of dependencies in `mix.exs`:

```elixir
def deps do
[
{:req_llm, "~> 1.6"}
]
end
```

Then run:

```bash
mix deps.get
```

## Quick Start

```elixir
Expand Down