ank/framed-rs
1
Fork 0
Code Issues Activity

Update docs.

Browse source
This commit is contained in:
Alex Helfet 2017-12-22 20:24:30 +00:00
parent 9e2622648b
commit b8a2f14694
2 changed files with 11 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
Cargo.toml
View file

@ -7,7 +7,13 @@ categories = ["embedded", "encoding", "network-programming"]
keywords = ["no_std", "networking", "datalink", "protocol", "embedded"] keywords = ["no_std", "networking", "datalink", "protocol", "embedded"]
readme = "README.md" readme = "README.md"
license = "MIT OR Apache-2.0" license = "MIT OR Apache-2.0"
repository = "https://github.com/fluffysquirrels/framed"
documentation = "https://docs.rs/framed"
repository = "https://github.com/fluffysquirrels/framed-rs"
[badges.travis-ci]
repository = "https://github.com/fluffysquirrels/framed-rs"
branch = "master"
[dependencies] [dependencies]
cobs = "^0.1.3" cobs = "^0.1.3"
@ -19,5 +25,5 @@ default = ["use_std"]
# Enable to print all data to stdout for testing. # Enable to print all data to stdout for testing.
trace = [] trace = []
# Use standard library, enabled by default; disable for no_std. # Use standard library. Enabled by default, disable for no_std.
use_std = [] use_std = []

4
src/lib.rs
View file

@ -1,6 +1,6 @@
//! Send and receive slices of bytes over lossy streams of bytes. //! Send and receive slices of bytes over lossy streams of bytes.
//! //!
//! Conforming to / inspired by the [data link layer][dll] or layer 2 //! Living in / inspired by the [data link layer][dll] or layer 2
//! in the OSI networking model, this module enables sending slices of //! in the OSI networking model, this module enables sending slices of
//! bytes of definite length over an underlying lossy transport that //! bytes of definite length over an underlying lossy transport that
//! only supports sending an unstructured stream of bytes (a [physical //! only supports sending an unstructured stream of bytes (a [physical
@ -31,7 +31,7 @@
//! //!
//! ## Cargo feature flags //! ## Cargo feature flags
//! //!
//! `use_std`: Use standard library, enabled by default; disable for no_std. //! `use_std`: Use standard library. Enabled by default, disable for no_std.
//! //!
//! `trace`: Enable to print all data to stdout for testing. //! `trace`: Enable to print all data to stdout for testing.
//! //!