quentin
/
boitalettres
forked from KokaKiwi/boitalettres
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

doc: Add some notes on the draft doc (+typo)

This commit is contained in:
Jill 2022-05-10 17:49:39 +02:00
parent 40c680fa1f
commit 7571eacb82
Signed by untrusted user: KokaKiwi
GPG Key ID: 09A5A2688F13FAC1
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/draft.md
View File

@ -1,6 +1,6 @@
# Just Enough Doc
## Rum `simple` example
## Run `simple` example
This example is meant to show basic service-based IMAP server with boitalettres library.
@ -16,6 +16,10 @@ $ cargo run --example simple
$ python scripts/test_imap.py
```
## Notes
- The library use the `tracing` library for logging, a basic setup is shown in the `simple` example with the `tracing-subscriber` crate.
## References
- [`imap-codec`](https://docs.rs/imap-codec): IMAP protocol model+encoder/decoder