Skip to content

Commit 4a53048

Browse files
chore: update readme to include clear instructions on how to install
1 parent 33b163c commit 4a53048

1 file changed

Lines changed: 30 additions & 0 deletions

File tree

README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,36 @@ Developed with 💙 by [Very Good Ventures][vgv_link] 🦄
1111

1212
Very Good AI Flutter Plugin is a collection of contextual best-practices skills that Claude uses when helping you write Flutter and Dart code. Each skill provides opinionated, production-quality guidance covering architecture patterns, naming conventions, folder structures, code examples, testing strategies, and anti-patterns to avoid, so you get code that follows [VGV standards][vgv_link] out of the box.
1313

14+
## Installation
15+
16+
### Project-level (recommended)
17+
18+
Install the plugin for a specific project so every collaborator benefits automatically:
19+
20+
```bash
21+
claude plugin add --project https://github.com/VeryGoodOpenSource/very_good_ai_flutter_plugin
22+
```
23+
24+
This writes the plugin reference into your project's `.claude/plugins.json`, which you can commit to source control.
25+
26+
### Global
27+
28+
Install the plugin once for all projects on your machine:
29+
30+
```bash
31+
claude plugin add https://github.com/VeryGoodOpenSource/very_good_ai_flutter_plugin
32+
```
33+
34+
### Verify installation
35+
36+
Run the following to confirm the plugin is active:
37+
38+
```bash
39+
claude plugin list
40+
```
41+
42+
You should see `very-good-ai-flutter-plugin` in the output.
43+
1444
## Skills
1545

1646
| Skill | Description |

0 commit comments

Comments
 (0)