summaryrefslogtreecommitdiff
path: root/plugins/react-native/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/react-native/README.md')
-rw-r--r--plugins/react-native/README.md38
1 files changed, 38 insertions, 0 deletions
diff --git a/plugins/react-native/README.md b/plugins/react-native/README.md
new file mode 100644
index 000000000..d1fce0fc2
--- /dev/null
+++ b/plugins/react-native/README.md
@@ -0,0 +1,38 @@
+# React Native plugin
+
+This plugin adds completion for [`react-native`](https://facebook.github.io/react-native/).
+It also defines a few [aliases](#aliases) for the commands more frequently used.
+
+To enable, add `react-native` to your `plugins` array in your zshrc file:
+
+```zsh
+plugins=(... react-native)
+```
+
+## Aliases
+
+| Alias | React Native command |
+| :------------ | :------------------------------------------------- |
+| **rn** | `react-native` |
+| **rns** | `react-native start` |
+| **rnlink** | `react-native link` |
+| _App testing_ |
+| **rnand** | `react-native run-android` |
+| **rnios** | `react-native run-ios` |
+| **rnios4s** | `react-native run-ios --simulator "iPhone 4s"` |
+| **rnios5** | `react-native run-ios --simulator "iPhone 5"` |
+| **rnios5s** | `react-native run-ios --simulator "iPhone 5s"` |
+| **rnios6** | `react-native run-ios --simulator "iPhone 6"` |
+| **rnios6s** | `react-native run-ios --simulator "iPhone 6s"` |
+| **rnios7** | `react-native run-ios --simulator "iPhone7"` |
+| **rnios7p** | `react-native run-ios --simulator "iPhone 7 Plus"` |
+| **rnios8** | `react-native run-ios --simulator "iPhone 8"` |
+| **rnios8p** | `react-native run-ios --simulator "iPhone 8 Plus"` |
+| **rniosse** | `react-native run-ios --simulator "iPhone SE"` |
+| **rniosx** | `react-native run-ios --simulator "iPhone X"` |
+| **rniosxs** | `react-native run-ios --simulator "iPhone XS"` |
+| **rniosxsm** | `react-native run-ios --simulator "iPhone XS Max"` |
+| **rniosxr** | `react-native run-ios --simulator "iPhone XR"` |
+| _Logging_ |
+| **rnland** | `react-native log-android` |
+| **rnlios** | `react-native log-ios` |