From f5e0b1fa0e25da2966954b5fa63c37a9cbe8ea80 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc=20Cornell=C3=A0?= Date: Sat, 17 Dec 2016 22:44:25 +0100 Subject: [PATCH] Update README for react-native plugin Fix format and add a brief description --- plugins/react-native/README.md | 33 +++++++++++++++++++-------------- 1 file changed, 19 insertions(+), 14 deletions(-) diff --git a/plugins/react-native/README.md b/plugins/react-native/README.md index 7511a7d98..b78bae17d 100644 --- a/plugins/react-native/README.md +++ b/plugins/react-native/README.md @@ -1,18 +1,23 @@ -# React Native +# React Native plugin -**Maintainers:** -[BilalBudhani](https://github.com/BilalBudhani) -[MauroPorrasP](https://github.com/mauroporrasp) +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 -------|--------------------- -**rn** | *react-native* -**rns** | *react-native start* -**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` | +| _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"` |