Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 2 additions & 1 deletion blacksheep/docs/asgi.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
BlackSheep is an [ASGI](https://asgi.readthedocs.io/en/latest/) web framework,
which requires an ASGI HTTP server to run, such as
[Uvicorn](http://www.uvicorn.org/), or
[Hypercorn](https://pgjones.gitlab.io/hypercorn/). All examples in this
[Hypercorn](https://pgjones.gitlab.io/hypercorn/) or
[granian](https://github.com/emmett-framework/granian). All examples in this
documentation use `Uvicorn`, but the framework has also been tested with
Hypercorn and should work with any server that implements the `ASGI`
specification.
Expand Down
3 changes: 2 additions & 1 deletion blacksheep/docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,8 @@ python -m venv venv

BlackSheep is an [ASGI](https://asgi.readthedocs.io/en/latest/) web framework,
so it requires an ASGI HTTP server like [uvicorn](http://www.uvicorn.org/), or
[hypercorn](https://pgjones.gitlab.io/hypercorn/). Install `uvicorn` and
[hypercorn](https://pgjones.gitlab.io/hypercorn/) or
[granian](https://github.com/emmett-framework/granian). Install `uvicorn` and
`blacksheep` for this tutorial:

```bash
Expand Down
5 changes: 3 additions & 2 deletions blacksheep/docs/websocket.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,9 @@ real-time applications, such as chat apps and similar use cases.

BlackSheep can handle incoming WebSocket connections when used with an ASGI
server that supports the WebSocket protocol (e.g.,
[Uvicorn](https://www.uvicorn.org/#quickstart) or
[Hypercorn](https://pgjones.gitlab.io/hypercorn/)).
[Uvicorn](https://www.uvicorn.org/#quickstart),
[Hypercorn](https://pgjones.gitlab.io/hypercorn/) or
[Granian](https://github.com/emmett-framework/granian)).

## Creating a WebSocket route

Expand Down