Skip to content

Commit

Permalink
update installation and config docs
Browse files Browse the repository at this point in the history
  • Loading branch information
darwin67 committed Nov 28, 2023
1 parent d997476 commit bb0d75c
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 5 deletions.
9 changes: 5 additions & 4 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ in `mix.exs`:
# mix.exs
def deps do
[
{:inngest, "~> 0.1"}
{:inngest, "~> 0.2"}
]
end
```
Expand All @@ -21,10 +21,11 @@ Then run `mix deps.get` to download the package.
The Elixir SDK currently uses `Tesla` for handling HTTP requests. While this might
not be ideal for some folks, it's the only option that can swap out the underlying HTTP
libraries while still providing a similar interface.
And it was the easiest to get something out quickly while still providing that portability.

Until there's either a standard `Protocol` defined for handling HTTP calls or HTTP libraries
actually being standardized, or a better way of abstracting the HTTP interfaces away, `Tesla`
will likely be here to stay.
We will be looking into removing this dependency completely in the future with
[`Mint`](https://hexdocs.pm/mint/api-reference.html) or just pure
[`:httpc`](https://www.erlang.org/doc/man/httpc.html).

### Tesla adapters

Expand Down
2 changes: 1 addition & 1 deletion docs/references/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ config :inngest, app_name: "MyApp"

### App Host

Default value: "http://127.0.0.1:4000"
Default value: `"http://127.0.0.1:4000"`

The app host to be used when deployed.

Expand Down

0 comments on commit bb0d75c

Please sign in to comment.