From cf319f14602b8005c75109d89d16167ded1ec601 Mon Sep 17 00:00:00 2001 From: spieljs Date: Sun, 17 May 2020 12:26:41 +0200 Subject: [PATCH] update documentation --- Cargo.toml | 2 +- README.md | 2 +- src/lib.rs | 4 ++-- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index 21006d7..31e47c5 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "spielrs_diff" -description= "It is a library which compare two tree direcories or two files asynchronously" +description= "It is a library which compare two direcories or two files asynchronously" version = "0.2.0" documentation = "https://docs.rs/crate/spielrs_diff/0.2.0" authors = ["Francisco Jesus Navarro Cortes "] diff --git a/README.md b/README.md index d9a1b4d..a1bfc5c 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # Spielrs Diff -It is a library which compare two tree direcories or two files asynchronously through [tokio](https://tokio.rs) +It is a library which compare two directories or two files asynchronously through [tokio](https://tokio.rs) and return true in case that both are different. Useful to create watchers in the servers ## How install it diff --git a/src/lib.rs b/src/lib.rs index ec98796..aa1e993 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,6 +1,6 @@ //! //! # Spielrs Diff -//! It is a library which compare two tree direcories or two files asynchronously through [tokio](https://tokio.rs) +//! It is a library which compare two directories or two files asynchronously through [tokio](https://tokio.rs) //! and return true in case that both are different. Useful to create watchers in the servers //! //! ## How install it @@ -52,7 +52,7 @@ use diff::{DirDiff, FileDiff}; use tokio::fs; use tree::{Tree, TreeBuilder}; -/// Compare two tree directories and return true if both are different +/// Compare two directories and return true if both are different /// You can exclude directories or files in the comparation only from the root path /// of both or recursively ///