summaryrefslogtreecommitdiff
path: root/plugins/react-native/README.md
diff options
context:
space:
mode:
authorTuowen Zhao <ztuowen@gmail.com>2016-12-25 08:01:49 -0700
committerTuowen Zhao <ztuowen@gmail.com>2016-12-25 08:01:49 -0700
commit0ebfa3a504a0a4de40154432918c5f8acb33bdae (patch)
tree3f75aab75e1e031ebb74ea77501a0b2303203049 /plugins/react-native/README.md
parent8f5c00c3374af83a45f541ac0c7d81f6b6219c5d (diff)
parent97c03841691021f916c46b2fd2d089d7970400aa (diff)
downloadzsh-0ebfa3a504a0a4de40154432918c5f8acb33bdae.tar.gz
zsh-0ebfa3a504a0a4de40154432918c5f8acb33bdae.tar.bz2
zsh-0ebfa3a504a0a4de40154432918c5f8acb33bdae.zip
Merge branch 'master' of https://github.com/robbyrussell/oh-my-zsh
Diffstat (limited to 'plugins/react-native/README.md')
-rw-r--r--plugins/react-native/README.md32
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"` |