Skip to content

Commit

Permalink
docs: fix links in crate readme
Browse files Browse the repository at this point in the history
  • Loading branch information
threadexio committed Dec 17, 2023
1 parent 0bd4c6e commit 0fc3ffd
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,14 @@
[downloads-badge]: https://img.shields.io/crates/d/channels?style=for-the-badge&label=downloads&labelColor=%23000&color=%23ff0089

<div align="center">
<!--
-->
<img src="https://raw.githubusercontent.com/threadexio/channels-rs/master/.github/images/logo.transparent.png" alt="logo">

<!--
For testing local changes.
<img src=".github/images/logo.transparent.png" alt="logo">
-->

<p>
Easy and fast communication between processes, threads and systems.
Expand Down Expand Up @@ -73,7 +80,7 @@ For more, see: [examples/](https://github.com/threadexio/channels-rs/tree/master

Some more complete examples:

- [chat-app](./examples/chat-app)
- [chat-app](https://github.com/threadexio/channels-rs/tree/master/examples/chat-app)

# How it works

Expand All @@ -83,10 +90,10 @@ Channels implements a communication protocol that allows sending and receiving d
- [`tokio::io::{AsyncRead, AsyncWrite}`](https://docs.rs/tokio/latest/tokio/io)
- [`futures::io::{AsyncRead, AsyncWrite}`](https://docs.rs/futures/latest/futures/io)

You can find out more about how the underlying communication protocol works [here](./spec/PROTOCOL.md).
You can find out more about how the underlying communication protocol works [here](https://github.com/threadexio/channels-rs/blob/master/spec/PROTOCOL.md).

# License

- All code in this repository is licensed under the MIT license, a copy of which can be found [here](./LICENSE).
- All code in this repository is licensed under the MIT license, a copy of which can be found [here](https://github.com/threadexio/channels-rs/blob/master/LICENSE).

- All artwork in this repository is licensed under [Creative Commons Attribution-NonCommercial 4.0 International](https://creativecommons.org/licenses/by-nc/4.0/). A copy of the license can be found [here](./.github/images/LICENSE).

0 comments on commit 0fc3ffd

Please sign in to comment.