Skip to content

Commit bb4a2fc

Browse files
authored
chore: adjust readme (#36)
1 parent 935e79a commit bb4a2fc

File tree

2 files changed

+6
-2
lines changed

2 files changed

+6
-2
lines changed

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11

22
# CLI Completion
33

4-
[![Very Good Ventures][logo_white]][very_good_ventures_link_dark]
54
[![Very Good Ventures][logo_black]][very_good_ventures_link_light]
5+
[![Very Good Ventures][logo_white]][very_good_ventures_link_dark]
6+
67

78
[![ci][ci_badge]][ci_link]
89
[![coverage][coverage_badge]][ci_link]
@@ -12,6 +13,8 @@
1213

1314
---
1415

16+
![screen][screen_gif]
17+
1518
Completion functionality for Dart Command-Line Interfaces built using `CommandRunner`.
1619

1720
Developed with 💙 by [Very Good Ventures][very_good_ventures_link] 🦄
@@ -41,7 +44,7 @@ class ExampleCommandRunner extends CompletionCommandRunner<int> {
4144
This will make the first command run to install the completion files automatically. To disable that behavior, set `enableAutoInstall` to false:
4245

4346
```dart
44-
class ExampleCommandRunner extends **CompletionCommandRunner**<int> {
47+
class ExampleCommandRunner extends CompletionCommandRunner<int> {
4548
4649
@override
4750
bool get enableAutoInstall => false;
@@ -81,6 +84,7 @@ Future<int?> runCommand(ArgResults topLevelResults) async {
8184
[dart_install_link]: https://dart.dev/get-dart
8285
[license_badge]: https://img.shields.io/badge/license-MIT-blue.svg
8386
[license_link]: https://opensource.org/licenses/MIT
87+
[screen_gif]: https://raw.githubusercontent.com/VeryGoodOpenSource/cli_completion/main/doc/screen.gif
8488
[logo_black]: https://raw.githubusercontent.com/VGVentures/very_good_brand/main/styles/README/vgv_logo_black.png#gh-light-mode-only
8589
[logo_white]: https://raw.githubusercontent.com/VGVentures/very_good_brand/main/styles/README/vgv_logo_white.png#gh-dark-mode-only
8690
[very_good_analysis_badge]: https://img.shields.io/badge/style-very_good_analysis-B22C89.svg

doc/screen.gif

553 KB
Loading

0 commit comments

Comments
 (0)