diff --git a/packages/cli/templates/default-plugin/README.md.hbs b/packages/cli/templates/default-plugin/README.md.hbs index 850537d542..d6f2d65134 100644 --- a/packages/cli/templates/default-plugin/README.md.hbs +++ b/packages/cli/templates/default-plugin/README.md.hbs @@ -1,6 +1,13 @@ -# Title +# {{id}} + Welcome to the {{id}} plugin! -## Sub-section 1 +_This plugin was created through the Backstage CLI_ -## Sub-section 2 +## Getting started + +Your plugin has been added to the example app in this repository, meaning you'll be able to access it by running `yarn start` in the root directory, and then navigating to [/{{id}}](http://localhost:3000/{{id}}). + +You can also serve the plugin in isolation by running `yarn start` in the plugin directory. +This method of serving the plugin provides quicker iteration speed and a faster startup and hot reloads. +It is only meant for local development, and the setup for it can be found inside the [/dev](/dev) directory.