Skip to content

📝: Update README for v0.3.0 #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Teufelchen1 merged 1 commit into from
Jun 23, 2025
Merged

📝: Update README for v0.3.0 #13

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 15 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
[![Clippy & co](https://github.com/Teufelchen1/slipmux/actions/workflows/rust.yml/badge.svg)](https://github.com/Teufelchen1/slipmux/actions/workflows/rust.yml)
[![Crates.io](https://img.shields.io/crates/v/slipmux.svg)](https://crates.io/crates/slipmux)
[![Documentation](https://docs.rs/slipmux/badge.svg)](https://docs.rs/slipmux)
# Slipmux: Using an UART interface for diagnostics, configuration, and packet transfer

Pure Rust implementation of [draft-bormann-t2trg-slipmux-03](https://datatracker.ietf.org/doc/html/draft-bormann-t2trg-slipmux-03).

Note: Frame aborting is not implemented!

## What is Slipmux

Expand All @@ -15,6 +16,13 @@ diagnostic frames and configuration messages.
Diagnostic frames are UTF-8 encoded strings intended as human-readable messages.
Configuration messages are serialized `CoAP` messages.

## Usage

Add `slipmux` to the dependencies in your `Cargo.toml`. This crate requires `std` by default via the `std` feature. You can disable this by adding `default-features = false` to the entry, which will make this crate `no_std` compatible.

Check [docs.rs](https://docs.rs/slipmux/latest/slipmux/) for examples and documentation on the programming API.
For even more examples, take a look at the unittests on the bottom of [src/framehandler.rs](https://github.com/Teufelchen1/slipmux/blob/main/src/framehandler.rs).

## Todo

- [x] Remove coap-lite dep
Expand All @@ -24,12 +32,13 @@ Configuration messages are serialized `CoAP` messages.
- [x] Implement frame abort
- [ ] Encoder (this crate does not take control over the transmission, it has no way of aborting)
- [x] Decoder
- [ ] Make crate optional `#[no_std]`
- [ ] Rethink public interfaces (generalise the usability):
- [ ] Currently wild mix of `[u8]` and `Vec<u8>`
- [ ] Impossible to know if the deocder is completely done or if bytes remain in its buffer
- [ ] Error handling is tedious
- [x] Make crate optional `#[no_std]`
- [x] Rethink public interfaces (generalise the usability):
- [x] Currently wild mix of `[u8]` and `Vec<u8>`
- [x] Impossible to know if the deocder is completely done or if bytes remain in its buffer
- [x] Error handling is tedious
- [ ] Interoperability tests with other slipmux implementations
- [ ] Polishing, QoL improvments, incorporating feedback from experienced crate publishern

## License

Expand Down