diff --git a/README.md b/README.md index ae98d70..c0cfcdf 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,21 @@ CI build on Travis CI: [![Build Status](https://travis-ci.org/fluffysquirrels/fr Pull requests welcome. +## Sub-crates + +* `framed` in directory `./framed`: + + The core library. + +* `framed_decode` in directory `./decode`: + + A command line tool to decode data encoded by the library. + +* `framed_test_type` in directory `./test_type`: + + A crate for testing `framed`: a library with encodable types + and a binary that outputs encoded data. + ## License Licensed under either of diff --git a/decode/Cargo.toml b/decode/Cargo.toml index 4e182e6..3566ad0 100644 --- a/decode/Cargo.toml +++ b/decode/Cargo.toml @@ -2,9 +2,9 @@ name = "framed_decode" version = "0.1.0" authors = ["Alex Helfet "] -description = """Send and receive data over lossy streams of bytes. +description = """`framed` sends and receives data over lossy streams of bytes. -TODO. +`framed_decode` is a command line tool to decode data encoded by the `framed` library. """ categories = ["no-std", "embedded", "encoding", "network-programming"] keywords = ["no_std", "networking", "datalink", "protocol", "embedded"] diff --git a/test_type/Cargo.toml b/test_type/Cargo.toml index ad3569a..96430f8 100644 --- a/test_type/Cargo.toml +++ b/test_type/Cargo.toml @@ -2,7 +2,10 @@ name = "framed_test_type" version = "0.1.0" authors = ["Alex Helfet "] -description = "Send and receive data over lossy streams of bytes." +description = """`framed` sends and receives data over lossy streams of bytes. + +`framed_test_type` is a crate for testing `framed`: a library with encodable types and a binary that outputs encoded data. +""" categories = ["no-std", "embedded", "encoding", "network-programming"] keywords = ["no_std", "networking", "datalink", "protocol", "embedded"] readme = "../README.md"