Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ken-matsui committed Nov 11, 2021
1 parent edf403d commit e0ab105
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# suggestion

This library Pprovides suggestion traits for all collection types in the standard library.

## Example

```rust
use suggestion::Suggest;

fn main() {
let input = "instakk";

let list_commands = vec!["update", "install"];
if list_commands.contains(&input) {
return;
}

if let Some(sugg) = list_commands.suggest(input) {
println!("No command named `{}` found.", input);
println!("Did you mean `{}`?", sugg);
}
}
```

```shell
$ cargo run
No command named `instakk` found.
Did you mean `install`?
```

0 comments on commit e0ab105

Please sign in to comment.