52723876f95a5b9cd7e4a07c6596a6d42b6be56f

Author
Marc Cornellà <marc.cornella@live.com>
Committer
Marc Cornellà <marc.cornella@live.com>
Date

Message

Add README to meteor plugin

Diff

 1diff --git a/plugins/meteor/README.md b/plugins/meteor/README.md
 2new file mode 100644
 3index 0000000000000000000000000000000000000000..4bee87f8faa5d834dc339000b199220e53bb3b08
 4--- /dev/null
 5+++ b/plugins/meteor/README.md
 6@@ -0,0 +1,45 @@
 7+## Introduction
 8+
 9+The [meteor plugin](https://github.com/robbyrussell/oh-my-zsh/tree/master/plugins/meteor) provides many
10+[useful aliases](#aliases) as well as completion for the `meteor` command.
11+
12+Enable it by adding `meteor` to the plugins array in your zshrc file:
13+```zsh
14+plugins=(... meteor)
15+```
16+
17+## Aliases
18+
19+| Alias   | Command                    | Description                                                      |
20+|---------|----------------------------|------------------------------------------------------------------|
21+| `ma`    | `meteor add`               | Add a package to this project                                    |
22+| `map`   | `meteor add-platform`      | Add a platform to this project                                   |
23+| `mad`   | `meteor admin`             | Administrative commands                                          |
24+| `mau`   | `meteor authorized`        | View or change authorized users and organizations for a site     |
25+| `mb`    | `meteor build`             | Build this project for all platforms                             |
26+| `mcl`   | `meteor claim`             | Claim a site deployed with an old Meteor version                 |
27+| `mca`   | `meteor configure-android` | Run the Android configuration tool from Meteor's ADK environment |
28+| `mc`    | `meteor create`            | Create a new project                                             |
29+| `mdb`   | `meteor debug`             | Run the project, but suspend the server process for debugging    |
30+| `mde`   | `meteor deploy`            | Deploy this project to Meteor                                    |
31+| `mis`   | `meteor install-sdk`       | Installs SDKs for a platform                                     |
32+| `ml`    | `meteor list`              | List the packages explicitly used by your project                |
33+| `mlp`   | `meteor list-platforms`    | List the platforms added to your project                         |
34+| `mls`   | `meteor list-sites`        | List sites for which you are authorized                          |
35+| `mli`   | `meteor login`             | Log in to your Meteor developer account                          |
36+| `mlo`   | `meteor logout`            | Log out of your Meteor developer account                         |
37+| `mlog`  | `meteor logs`              | Show logs for specified site                                     |
38+| `mm`    | `meteor mongo`             | Connect to the Mongo database for the specified site             |
39+| `mp`    | `meteor publish`           | Publish a new version of a package to the package server         |
40+| `mpa`   | `meteor publish-for-arch`  | Builds an already-published package for a new platform           |
41+| `mpr`   | `meteor publish-release`   | Publish a new meteor release to the package server               |
42+| `mr`    | `meteor remove`            | Remove a package from this project                               |
43+| `mrp`   | `meteor remove-platform`   | Remove a platform from this project                              |
44+| `mre`   | `meteor reset`             | Reset the project state. Erases the local database               |
45+| `m`     | `meteor run`               | **[default]** Run this project in local development mode         |
46+| `ms`    | `meteor search`            | Search through the package server database                       |
47+| `msh`   | `meteor shell`             | Launch a Node REPL for interactively evaluating server-side code |
48+| `msw`   | `meteor show`              | Show detailed information about a release or package             |
49+| `mt`    | `meteor test-packages`     | Test one or more packages                                        |
50+| `mu`    | `meteor update`            | Upgrade this project's dependencies to their latest versions     |
51+| `mw`    | `meteor whoami`            | Prints the username of your Meteor developer account             |