Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added recordings of examples to the readme #258

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
62 changes: 56 additions & 6 deletions README.md
Expand Up @@ -8,12 +8,62 @@ A rust library for command line prompts and similar things.

Best paired with other libraries in the family:

* [console](https://github.com/console-rs/console)
* [indicatif](https://github.com/console-rs/indicatif)
- [console](https://github.com/console-rs/console)
- [indicatif](https://github.com/console-rs/indicatif)

## Here are some examples what this crate can do:

### Confirmation example

![An SVG animation of the confirm example being run in a terminal](img/confirm.svg?raw=true)

### Input example

![An SVG animation of the input example being run in a terminal](img/input.svg?raw=true)

### Fuzzy select example

![An SVG animation of the fuzzy_select example being run in a terminal](img/fuzzy_select.svg?raw=true)

### Select example

![An SVG animation of the select example being run in a terminal](img/select.svg?raw=true)

### Completion example

![An SVG animation of the completion example being run in a terminal](img/completion.svg?raw=true)

### Password example

![An SVG animation of the password example being run in a terminal](img/password.svg?raw=true)

### Editor example

![An SVG animation of the editor example being run in a terminal](img/editor.svg?raw=true)

### History example

![An SVG animation of the history example being run in a terminal](img/history.svg?raw=true)

### Sort example

![An SVG animation of the sort example being run in a terminal](img/sort.svg?raw=true)

### Multi Select example

![An SVG animation of the multi_select example being run in a terminal](img/multi_select.svg?raw=true)

### Wizard example

![An SVG animation of the wizard example being run in a terminal](img/wizard.svg?raw=true)

### Paging example

![An SVG animation of the paging example being run in a terminal](img/paging.svg?raw=true)

## License and Links

* [Documentation](https://docs.rs/dialoguer/)
* [Issue Tracker](https://github.com/console-rs/dialoguer/issues)
* [Examples](https://github.com/console-rs/dialoguer/tree/master/examples)
* License: [MIT](https://github.com/console-rs/dialoguer/blob/main/LICENSE)
- [Documentation](https://docs.rs/dialoguer/)
- [Issue Tracker](https://github.com/console-rs/dialoguer/issues)
- [Examples](https://github.com/console-rs/dialoguer/tree/master/examples)
- License: [MIT](https://github.com/console-rs/dialoguer/blob/main/LICENSE)
147 changes: 147 additions & 0 deletions img/completion.svg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
123 changes: 123 additions & 0 deletions img/confirm.svg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
220 changes: 220 additions & 0 deletions img/editor.svg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
198 changes: 198 additions & 0 deletions img/fuzzy_select.svg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
101 changes: 101 additions & 0 deletions img/history.svg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
141 changes: 141 additions & 0 deletions img/input.svg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
101 changes: 101 additions & 0 deletions img/multi_select.svg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
122 changes: 122 additions & 0 deletions img/paging.svg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
79 changes: 79 additions & 0 deletions img/password.svg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
84 changes: 84 additions & 0 deletions img/select.svg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
125 changes: 125 additions & 0 deletions img/sort.svg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
101 changes: 101 additions & 0 deletions img/wizard.svg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.