Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
dancespiele committed May 17, 2020
1 parent 72a136c commit cf319f1
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -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 <[email protected]>"]
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
4 changes: 2 additions & 2 deletions src/lib.rs
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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
///
Expand Down

0 comments on commit cf319f1

Please sign in to comment.