forked from KokaKiwi/boitalettres
doc: Add some notes on the draft doc (+typo)
This commit is contained in:
parent
40c680fa1f
commit
7571eacb82
1 changed files with 5 additions and 1 deletions
|
@ -1,6 +1,6 @@
|
||||||
# Just Enough Doc
|
# Just Enough Doc
|
||||||
|
|
||||||
## Rum `simple` example
|
## Run `simple` example
|
||||||
|
|
||||||
This example is meant to show basic service-based IMAP server with boitalettres library.
|
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
|
$ 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
|
## References
|
||||||
|
|
||||||
- [`imap-codec`](https://docs.rs/imap-codec): IMAP protocol model+encoder/decoder
|
- [`imap-codec`](https://docs.rs/imap-codec): IMAP protocol model+encoder/decoder
|
||||||
|
|
Loading…
Reference in a new issue