expose diskus internals as library

2 files changed, 19 insertions, 0 deletions

diff --git a/src/lib.rs b/src/lib.rs
new file mode 100644
index 0000000..82d359f
--- /dev/null
+++ b/src/lib.rs
@@ -0,0 +1,7 @@
+extern crate crossbeam_channel;
+extern crate humansize;
+extern crate num_cpus;
+extern crate rayon;
+
+pub mod walk;
+pub use walk::Walk;
diff --git a/src/walk.rs b/src/walk.rs
index e1ccd25..d5523ad 100644
--- a/src/walk.rs
+++ b/src/walk.rs
@@ -61,6 +61,18 @@ fn walk(tx: channel::Sender<Message>, entries: &[PathBuf]) {
     });
 }
 
+/// Basic usage of diskus library
+///
+/// # Example:
+///
+/// ```rust
+/// fn foo() {
+///     let path = PathBuf::from("/");
+///     let paths = vec![path];
+///     let walk = Walk::new(&paths, 4);
+///     let size = walk.run();
+/// }
+/// ```
 pub struct Walk<'a> {
     root_directories: &'a [PathBuf],
     threads: usize,