diff --git a/README.md b/README.md index 4d508e2..4d4ba70 100644 --- a/README.md +++ b/README.md @@ -10,10 +10,26 @@ A fast one-pass in-place HTML minifier written in Rust with advanced whitespace ## Usage +### CLI + ```bash hyperbuild --src /path/to/src.html --out /path/to/output.min.html ``` +### API + +```rust +use hyperbuild::hyperbuild; + +fn main() { + let mut code = b"

Hello world!

"; + match hyperbuild(&mut code) { + Ok(minified_len) => {} + Err(error_type, error_at_char_no) => {} + }; +} +``` + ## Minification ### Whitespace diff --git a/fuzz/src/main.rs b/fuzz/src/main.rs index 22c9c8f..67bc6eb 100644 --- a/fuzz/src/main.rs +++ b/fuzz/src/main.rs @@ -1,5 +1,5 @@ use afl::fuzz; -use hyperbuild::hyperbuild; +use hyperbuild::{hyperbuild, ErrorType}; fn main() { fuzz!(|data: &[u8]| { diff --git a/src/lib.rs b/src/lib.rs index 209bcec..1b1b075 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,9 +1,9 @@ -use crate::err::ErrorType; +pub use crate::err::ErrorType as ErrorType; use crate::proc::Processor; use crate::unit::content::process_content; -pub mod err; -pub mod pattern; +mod err; +mod pattern; #[macro_use] mod proc; mod spec; diff --git a/src/main.rs b/src/main.rs index c8e0b96..148c101 100644 --- a/src/main.rs +++ b/src/main.rs @@ -3,8 +3,7 @@ use std::io::{Read, stderr, Write}; use structopt::StructOpt; -use hyperbuild::err::ErrorType; -use hyperbuild::hyperbuild; +use hyperbuild::{hyperbuild, ErrorType}; #[derive(StructOpt)] struct Cli {