Skip to content

Commit

Permalink
docs: fix example links in README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
gbaranski committed Mar 17, 2023
1 parent 68292c7 commit e2457a0
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,19 +14,20 @@ Creating a WebSocket server or a client in Rust can be troublesome. This crate f
View the full documentation at [docs.rs/ezsockets](http://docs.rs/ezsockets)

## Examples
- [`simple-client`](/examples/simple-client) - a simplest WebSocket client which uses stdin as input.
- [`echo-server`](/examples/echo-server) - server that echoes back every message it receives.
- [`counter-server`](/examples/counter-server) - server that increments global value every second and shares it with client
- [`chat-client`](/examples/chat-client) - chat client for `chat-server` and `chat-server-axum` examples
- [`chat-server`](/examples/chat-server) - chat server with support of rooms
- [`chat-server-axum`](/examples/chat-server-axum) - same as above, but using `axum` as a back-end
- [`simple-client`](https://github.com/gbaranski/ezsockets/tree/master/examples/chat-client) - a simplest WebSocket client which uses stdin as input.
- [`echo-server`](https://github.com/gbaranski/ezsockets/tree/master/examples/echo-server) - server that echoes back every message it receives.
- [`echo-server`](https://github.com/gbaranski/ezsockets/tree/master/examples/echo-server-native-tls) - same as `echo-server`, but with `native-tls`.
- [`counter-server`](https://github.com/gbaranski/ezsockets/tree/master/examples/counter-server) - server that increments global value every second and shares it with client
- [`chat-client`](https://github.com/gbaranski/ezsockets/tree/master/examples/chat-client) - chat client for `chat-server` and `chat-server-axum` examples
- [`chat-server`](https://github.com/gbaranski/ezsockets/tree/master/examples/chat-server) - chat server with support of rooms
- [`chat-server-axum`](https://github.com/gbaranski/ezsockets/tree/master/examples/chat-server-axum) - same as above, but using `axum` as a back-end


## Client

[`tokio-tungstenite`](https://github.com/snapview/tokio-tungstenite) is being used under the hood.

See [examples/simple-client](/examples/simple-client) for a simple usage
See [examples/simple-client](https://github.com/gbaranski/ezsockets/tree/master/examples/simple-client) for a simple usage
and [docs.rs/ezsockets/server](https://docs.rs/ezsockets/latest/ezsockets/client/index.html) for documentation.

## Server
Expand All @@ -36,5 +37,5 @@ WebSocket server can use one of supported back-ends:
- [`axum`](https://github.com/tokio-rs/axum) - ergonomic and modular web framework built with Tokio, Tower, and Hyper
- [`actix-web`](https://github.com/actix/actix-web) - Work in progress at [#22](https://github.com/gbaranski/ezsockets/issues/22)

See [examples/echo-server](/examples/echo-server) for a simple usage
See [examples/echo-server](https://github.com/gbaranski/ezsockets/tree/master/examples/echo-server) for a simple usage
and [docs.rs/ezsockets/server](https://docs.rs/ezsockets/latest/ezsockets/server/index.html) for documentation.

0 comments on commit e2457a0

Please sign in to comment.