*: update readme & add an example

Signed-off-by: Chojan Shang <[email protected]>

Author: PsiACE

README.md

@@ -1,11 +1,11 @@
-# fail-rs
+# failpoints, another fail-rsS
 
-[![CI](https://github.com/tikv/fail-rs/workflows/CI/badge.svg)](https://github.com/tikv/fail-rs/actions)
-[![Crates.io](https://img.shields.io/crates/v/fail.svg?maxAge=2592000)](https://crates.io/crates/fail)
+[![CI](https://github.com/ritelabs/failpoints/workflows/CI/badge.svg)](https://github.com/ritelabs/failpoints/actions)
+[![Crates.io](https://img.shields.io/crates/v/failpoints.svg?maxAge=2592000)](https://crates.io/crates/failpoints)
 
-[Documentation](https://docs.rs/fail).
+[Documentation](https://docs.rs/failpoints).
 
-A fail point implementation for Rust.
+A failpoints implementation for Rust.
 
 Fail points are code instrumentations that allow errors and other behavior to be injected dynamically at runtime, primarily for testing purposes. Fail points are flexible and can be configured to exhibit a variety of behavior, including panics, early returns, and sleeping. They can be controlled both programmatically and via the environment, and can be triggered conditionally and probabilistically.
 
@@ -17,19 +17,19 @@ First, add this to your `Cargo.toml`:
 
 ```toml
 [dependencies]
-fail = "0.4"
+failpoints = "0.1"
 ```
 
-Now you can import the `fail_point!` macro from the `fail` crate and use it to inject dynamic failures.
+Now you can import the `failpoint!` macro from the `failpoints` crate and use it to inject dynamic failures.
 Fail points generation by this macro is disabled by default, and can be enabled where relevant with the `failpoints` Cargo feature.
 
 As an example, here's a simple program that uses a fail point to simulate an I/O panic:
 
 ```rust
-use fail::{fail_point, FailScenario};
+use failpoints::{failpoint, FailScenario};
 
 fn do_fallible_work() {
-    fail_point!("read-dir");
+    failpoint!("read-dir");
     let _dir: Vec<_> = std::fs::read_dir(".").unwrap().collect();
     // ... do some work on the directory ...
 }
@@ -47,25 +47,21 @@ Here, the program calls `unwrap` on the result of `read_dir`, a function that re
 When the program is run normally it just prints "done":
 
 ```sh
-$ cargo run --features fail/failpoints
-    Finished dev [unoptimized + debuginfo] target(s) in 0.01s
-     Running `target/debug/failpointtest`
+$ cargo run
+     Finished dev [unoptimized + debuginfo] target(s) in 1.18s
+     Running `target/debug/failpoint`
 done
 ```
 
 But now, by setting the `FAILPOINTS` variable we can see what happens if the `read_dir` fails:
 
 ```
-FAILPOINTS=read-dir=panic cargo run --features fail/failpoints
+$ FAILPOINTS=read-dir=panic cargo run --features failpoints/failpoints
     Finished dev [unoptimized + debuginfo] target(s) in 0.01s
-     Running `target/debug/failpointtest`
-thread 'main' panicked at 'failpoint read-dir panic', /home/ubuntu/.cargo/registry/src/github.com-1ecc6299db9ec823/fail-0.2.0/src/lib.rs:286:25
-note: Run with `RUST_BACKTRACE=1` for a backtrace.
+     Running `target/debug/failpoint`
+thread 'main' panicked at 'failpoint read-dir panic', /home/psiace/Projects/ritelabs/dev/failpoints/src/lib.rs:498:25
+note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
 ```
 
-For further information see the [API documentation](https://docs.rs/fail).
-
-
-## TODO
+For further information see the [API documentation](https://docs.rs/failpoints).
 
-Triggering a fail point via the HTTP API is planned but not implemented yet.

examples/failpoint/Cargo.toml

@@ -0,0 +1,10 @@
+[package]
+name = "failpoint"
+version = "0.1.0"
+authors = ["Chojan Shang <[email protected]>"]
+edition = "2018"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+failpoints = { path = "../.." }

examples/failpoint/src/main.rs

@@ -0,0 +1,14 @@
+use failpoints::{failpoint, FailScenario};
+
+fn do_fallible_work() {
+    failpoint!("read-dir");
+    let _dir: Vec<_> = std::fs::read_dir(".").unwrap().collect();
+    // ... do some work on the directory ...
+}
+
+fn main() {
+    let scenario = FailScenario::setup();
+    do_fallible_work();
+    scenario.teardown();
+    println!("done");
+}