Merge pull request #764 from spotify/rugvip/pdocs

packages/cli: update plugin template README to explain next steps and plugin:serve
2020-05-08 16:05:45 +02:00
parent 66d056a46c fca8b3211e
commit ad1e2fec2b
1 changed files with 10 additions and 3 deletions
@@ -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.