sniffers/
lib.rs

1//! # sniffers
2//! 
3//! `sniffers` is a simple library for detecting file changes. This library contains 
4//! a library and a binary. The library is used to detect file changes in a directory,
5//! and the binary is used to detect file changes in a directory and run a command when 
6//! a change is detected.
7//! 
8//! ## Library
9//! 
10//! The library contains the core logic for detecting file changes.
11//! 
12//! ### Usage
13//! ```rust
14//! use sniffers::Sniffer;
15//! 
16//! let sniffer = Sniffer::default();
17//! 
18//! sniffer.index();
19//! 
20//! let altered_files = sniffer.sniff();
21//! 
22//! println!("{:?}", altered_files);
23//! ```
24//! 
25//! ## Binary
26//! 
27//! The binary wraps the library and provides a command line interface for detecting file changes.
28//! 
29//! ### Usage
30//! 
31//! ```bash
32//! sniffers index
33//! sniffers sniff
34//! ```
35
36pub mod consts;
37pub mod sniffer;
38pub mod utils;
39
40pub use sniffer::Sniffer;