From 49d47892fa6980363ee4941c4c1eaa15c0a52b04 Mon Sep 17 00:00:00 2001 From: Jeff Dickey <216188+jdxcode@users.noreply.github.com> Date: Thu, 22 Mar 2018 01:04:24 -0700 Subject: [PATCH] docs: explained friendly names --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 570063b9..c327b284 100644 --- a/README.md +++ b/README.md @@ -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