From b8a2f14694ea760ed7580c37b1591ab679e08785 Mon Sep 17 00:00:00 2001 From: Alex Helfet Date: Fri, 22 Dec 2017 20:24:30 +0000 Subject: [PATCH] Update docs. --- Cargo.toml | 12 +++++++++--- src/lib.rs | 4 ++-- 2 files changed, 11 insertions(+), 5 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index 1bc872d..b576006 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -7,7 +7,13 @@ categories = ["embedded", "encoding", "network-programming"] keywords = ["no_std", "networking", "datalink", "protocol", "embedded"] readme = "README.md" 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] cobs = "^0.1.3" @@ -19,5 +25,5 @@ default = ["use_std"] # Enable to print all data to stdout for testing. trace = [] -# Use standard library, enabled by default; disable for no_std. -use_std = [] \ No newline at end of file +# Use standard library. Enabled by default, disable for no_std. +use_std = [] diff --git a/src/lib.rs b/src/lib.rs index bd5ffc1..b77c3ae 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,6 +1,6 @@ //! 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 //! bytes of definite length over an underlying lossy transport that //! only supports sending an unstructured stream of bytes (a [physical @@ -31,7 +31,7 @@ //! //! ## 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. //!