Skip to content

docs: update README.md to remove references to functions removed in v5 #71

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
rawhat merged 2 commits into from
Jul 21, 2025
Merged

docs: update README.md to remove references to functions removed in v5 #71

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2117a5a
docs: remove reference to `mist.start_http` and `mist.start_https` fr…
tomalexhughes Jul 20, 2025
73b19e7
docs: re-format line length for updated text
tomalexhughes Jul 20, 2025
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
9 changes: 4 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,10 @@ $ cd <your_project>
$ gleam add mist logging gleam_erlang gleam_http gleam_otp gleam_yielder
```

The main entrypoints for your application are `mist.start_http` and
`mist.start_https`. The argument to these functions is generated from the
opaque `Builder` type. It can be constructed with the `mist.new` function, and
fed updated configuration options with the associated methods (demonstrated
in the examples below).
The main entrypoint for your application is `mist.start`. The argument to this
function is generated from the opaque `Builder` type. It can be constructed with
the `mist.new` function, and fed updated configuration options with the
associated methods (demonstrated in the examples below).

```gleam
import gleam/bytes_tree
Expand Down