add docs for the 'server' and 'storage' modules

This commit is contained in:
Dustin J. Mitchell
2021-01-10 22:02:42 -05:00
parent 02d9c577ab
commit ae4cee1ac3
2 changed files with 19 additions and 0 deletions

View File

@@ -1,3 +1,13 @@
/**
This module defines the client interface to TaskChampion sync servers.
It defines a [trait](crate::server::Server) for servers, and implements both local and remote servers.
Typical uses of this crate do not interact directly with this module; [`ServerConfig`](crate::ServerConfig) is sufficient.
However, users who wish to implement their own server interfaces can implement the traits defined here and pass the result to [`Replica`](crate::Replica).
*/
#[cfg(test)]
pub(crate) mod test;