Skip to content

Commit

Permalink
docs: explained friendly names
Browse files Browse the repository at this point in the history
  • Loading branch information
jdx committed Mar 22, 2018
1 parent 14b064a commit 49d4789
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,12 @@ First add the plugin to your project with `yarn add @oclif/plugin-plugins`, then

Now the user can run any of the commands below to manage plugins at runtime.

# Friendly names

To make it simpler for users to install plugins, we have "friendly name" functionality. With this, you can run `mycli plugins:install myplugin` and it will first check if `@mynpmorg/plugin-myplugin` exists on npm before trying to install `myplugin`. This is useful if you want to use a generic name that's already taken in npm.

To set this up, simply set the `oclif.scope` to the name of your npm org. In the example above, this would be `mynpmorg`.

<!-- commands -->
# Commands

Expand Down

0 comments on commit 49d4789

Please sign in to comment.