summaryrefslogtreecommitdiff
path: root/plugins/flutter/README.md
diff options
context:
space:
mode:
authorTuowen Zhao <ztuowen@gmail.com>2019-09-26 11:35:31 -0600
committerTuowen Zhao <ztuowen@gmail.com>2019-09-26 11:35:31 -0600
commit09829ba30c269e35bddf44a21f3357efd31e686f (patch)
tree8ad263cf7e6508ce9f947e6b9fc5c60a7d9fff76 /plugins/flutter/README.md
parentd676c1553254309beca5bb9a8edb43fbe09a7169 (diff)
parentf9e7c45a484723f693a77ab6128a1cc163f3704a (diff)
downloadzsh-09829ba30c269e35bddf44a21f3357efd31e686f.tar.gz
zsh-09829ba30c269e35bddf44a21f3357efd31e686f.tar.bz2
zsh-09829ba30c269e35bddf44a21f3357efd31e686f.zip
Merge remote-tracking branch 'origin/master'
Diffstat (limited to 'plugins/flutter/README.md')
-rw-r--r--plugins/flutter/README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/plugins/flutter/README.md b/plugins/flutter/README.md
new file mode 100644
index 000000000..be419144f
--- /dev/null
+++ b/plugins/flutter/README.md
@@ -0,0 +1,21 @@
+## Flutter plugin
+
+The Flutter plugin provides completion and useful aliases
+
+To use it, add flutter to the plugins array of your zshrc file:
+
+```
+plugins=(... flutter)
+```
+
+## Aliases
+
+| Alias | Command | Description |
+| :--------- | :--------------------- | :------------------------------------------------------------------------- |
+| `fl` | `flutter` | Shorthand for flutter command |
+| `flr` | `flutter run` | Runs flutter app |
+| `fldoc` | `flutter doctor` | Runs flutter doctor |
+| `flb` | `flutter build` | Build flutter application |
+| `flattach` | `flutter attach` | Attaches flutter to a running flutter application with enabled observatory |
+| `flget` | `flutter packages get` | Installs dependencies |
+| `flc` | `flutter clean` | Cleans flutter porject |