Skip to content

Commit d330167

Browse files
committed
Update README
1 parent 4124ca7 commit d330167

File tree

1 file changed

+21
-2
lines changed

1 file changed

+21
-2
lines changed

README.md

+21-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,24 @@
1-
# slip-codec
1+
slip-codec — SLIP Encoder/Decoder
2+
=================================
23

3-
SLIP encoder/decoder with Rust std::io::{Read, Write} interfaces.
4+
[![crates.io][crates-badge]][crates-url]
5+
[![docs.rs][docs-badge]][docs-url]
6+
[![MIT licensed][mit-badge]][mit-url]
7+
8+
SLIP encoder/decoder with Rust [std::io](https://doc.rust-lang.org/std/io/index.html)::{[Read](https://doc.rust-lang.org/std/io/trait.Read.html), [Write](https://doc.rust-lang.org/std/io/trait.Write.html)} interfaces.
49

510
Pure Rust implementation of [RFC 1055](https://tools.ietf.org/html/rfc1055) Serial Line Internet Protocol (SLIP). Test cases are lifted from the [serial_line_ip](https://crates.io/crates/serial-line-ip) crate that serves the same role, but uses slices for data handling.
11+
12+
## Optional features
13+
14+
Asynchronous interfaces are optionally provided in addition to the default synchronous interface.
15+
16+
* **`async-codec`** — Implements runtime agnostic [asynchronous_codec](https://crates.io/crates/asynchronous-codec) traits
17+
* **`tokio-codec`** — Implements [tokio](https://tokio.rs) runtime [tokio_util::codec](https://docs.rs/tokio-util/latest/tokio_util/codec/index.html) traits
18+
19+
[crates-badge]: https://img.shields.io/crates/v/slip-codec.svg
20+
[crates-url]: https://crates.io/crates/slip-codec
21+
[docs-badge]: https://docs.rs/slip-codec/badge.svg
22+
[docs-url]: https://docs.rs/slip-codec
23+
[mit-badge]: https://img.shields.io/badge/license-MIT-blue.svg
24+
[mit-url]: LICENSE

0 commit comments

Comments
 (0)