Add documentation on API usage; hide unnecessary API exports
This commit is contained in:
parent
b787276a62
commit
9c77c7a1c1
16
README.md
16
README.md
|
@ -10,10 +10,26 @@ A fast one-pass in-place HTML minifier written in Rust with advanced whitespace
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
|
### CLI
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
hyperbuild --src /path/to/src.html --out /path/to/output.min.html
|
hyperbuild --src /path/to/src.html --out /path/to/output.min.html
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### API
|
||||||
|
|
||||||
|
```rust
|
||||||
|
use hyperbuild::hyperbuild;
|
||||||
|
|
||||||
|
fn main() {
|
||||||
|
let mut code = b"<p>Hello world!</p>";
|
||||||
|
match hyperbuild(&mut code) {
|
||||||
|
Ok(minified_len) => {}
|
||||||
|
Err(error_type, error_at_char_no) => {}
|
||||||
|
};
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
## Minification
|
## Minification
|
||||||
|
|
||||||
### Whitespace
|
### Whitespace
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
use afl::fuzz;
|
use afl::fuzz;
|
||||||
use hyperbuild::hyperbuild;
|
use hyperbuild::{hyperbuild, ErrorType};
|
||||||
|
|
||||||
fn main() {
|
fn main() {
|
||||||
fuzz!(|data: &[u8]| {
|
fuzz!(|data: &[u8]| {
|
||||||
|
|
|
@ -1,9 +1,9 @@
|
||||||
use crate::err::ErrorType;
|
pub use crate::err::ErrorType as ErrorType;
|
||||||
use crate::proc::Processor;
|
use crate::proc::Processor;
|
||||||
use crate::unit::content::process_content;
|
use crate::unit::content::process_content;
|
||||||
|
|
||||||
pub mod err;
|
mod err;
|
||||||
pub mod pattern;
|
mod pattern;
|
||||||
#[macro_use]
|
#[macro_use]
|
||||||
mod proc;
|
mod proc;
|
||||||
mod spec;
|
mod spec;
|
||||||
|
|
|
@ -3,8 +3,7 @@ use std::io::{Read, stderr, Write};
|
||||||
|
|
||||||
use structopt::StructOpt;
|
use structopt::StructOpt;
|
||||||
|
|
||||||
use hyperbuild::err::ErrorType;
|
use hyperbuild::{hyperbuild, ErrorType};
|
||||||
use hyperbuild::hyperbuild;
|
|
||||||
|
|
||||||
#[derive(StructOpt)]
|
#[derive(StructOpt)]
|
||||||
struct Cli {
|
struct Cli {
|
||||||
|
|
Loading…
Reference in New Issue