diff options
Diffstat (limited to 'plugins/react-native/README.md')
| -rw-r--r-- | plugins/react-native/README.md | 32 |
1 files changed, 22 insertions, 10 deletions
diff --git a/plugins/react-native/README.md b/plugins/react-native/README.md index 78bfb6844..c6fe396b8 100644 --- a/plugins/react-native/README.md +++ b/plugins/react-native/README.md @@ -1,14 +1,26 @@ -# React Native +# React Native plugin -**Maintainer:** [BilalBudhani](https://github.com/BilalBudhani) +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. -### List of Aliases +To enable, add `react-native` to your `plugins` array in your zshrc file: -Alias | React Native command -------|--------------------- -**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"* +```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"` | |