Skip to content

Commit

Permalink
docs(README): add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
a8m committed Oct 14, 2015
1 parent 5753fe7 commit ca1b231
Showing 1 changed file with 50 additions and 0 deletions.
50 changes: 50 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# Console progress bar for Rust

Console progress bar for Rust Inspired from [pb.go](github.com/cheggaaa/pb), support and
tested on MacOS and Linux(should work on Windows too, but not tested yet).

### Examples
1. simple example

```rust
extern crate pb;

use pb::ProgressBar;
use std::thread;

fn main() {
let count = 1000;
let mut pb = ProgressBar::new(count);
for _ in 0..count {
pb.inc();
thread::sleep_ms(200);
}
println("done!");
}
```

2. Broadcast writing(simple file copying)

```rust
extern crate pb;

use std::io::copy;
use std::fs::{self, File};
use pb::{ProgressBar, Units};

fn main() {
let fname = "/usr/share/dict/words";
let mut file = File::open(fname).unwrap();
let n_bytes = fs::metadata(fname).unwrap().len() as usize;
let mut pb = ProgressBar::new(n_bytes);
pb.set_units(pb::Units::Bytes);
let mut dfile = File::create("copy-words").unwrap();
let mut handle = dfile.broadcast(&mut pb);
copy(&mut file, &mut handle).unwrap();
println!("done!");
}
```

### License
MIT

0 comments on commit ca1b231

Please sign in to comment.