From 91e0c6df73312ffd92bb1dc4b262307fcd2ce8c0 Mon Sep 17 00:00:00 2001 From: Ulf Lilleengen Date: Mon, 13 Dec 2021 13:23:18 +0100 Subject: [PATCH] Some notes in the readme about docs --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index fd856bb6..62aea006 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,6 @@ # Embassy -Embassy is a project to make async/await a first-class option for embedded development. For more information and instructions to -get started, click [here](https://github.com/embassy-rs/embassy/wiki). +Embassy is a project to make async/await a first-class option for embedded development. For more information and instructions to get started, go to [https://embassy.dev](https://embassy.dev). ## Traits and types @@ -93,6 +92,10 @@ Required nightly version is specified in the `rust-toolchain.toml` file. Nightly Stable support is a non-goal until these features get stabilized. +## Documentation + +Embassy documentation is located in the `docs/` folder. The documentation is built in [embassy-book](https://github.com/embassy-rs/embassy-book) and published to [https://embassy.dev](https://embassy.dev) by CI. + ## Why the name? EMBedded ASYnc! :)