]> code.octet-stream.net Git - m17rt/blobdiff - m17core/README.md
Update READMEs with API changes
[m17rt] / m17core / README.md
index cee5df0f30fe54ff68bd40981b0e2ba96befb11f..91b05d0ca42338728078cf88038bcc4933d18cde 100644 (file)
@@ -1,8 +1,8 @@
-# m17codec2
+# m17core
 
 Part of the [M17 Rust Toolkit](https://octet-stream.net/p/m17rt/).
 
 
 Part of the [M17 Rust Toolkit](https://octet-stream.net/p/m17rt/).
 
-This crate includes a modulator, demodulator, TNC, M17 data link parsing and encoding, KISS protocol handling, and other protocol utilities. It can be used to create an M17 transmitter or receiver, however you will have to connect everything together yourself. If possible, consider using the higher-level crate `m17app`.
+This crate includes a modulator, demodulator, TNC, M17 data link parsing and encoding, KISS protocol handling, UDP reflector packet formats, and other protocol utilities. It can be used to create an M17 transmitter or receiver, however you will have to connect everything together yourself. If possible, consider using the higher-level crate `m17app`.
 
 `m17core` is `no_std`, does not perform any heap allocations, and its protocol implementations are non-blocking and sans-I/O.
 
 
 `m17core` is `no_std`, does not perform any heap allocations, and its protocol implementations are non-blocking and sans-I/O.