From 9077e12261d811e4c24daa65f47d25cd4e3acdd3 Mon Sep 17 00:00:00 2001 From: Emma Indal Date: Mon, 22 Jun 2020 15:06:30 +0200 Subject: [PATCH] fix(techdocs-cli): update readme --- packages/techdocs-cli/README.md | 14 +++----------- 1 file changed, 3 insertions(+), 11 deletions(-) diff --git a/packages/techdocs-cli/README.md b/packages/techdocs-cli/README.md index f4b9534bfa..d7c17210bd 100644 --- a/packages/techdocs-cli/README.md +++ b/packages/techdocs-cli/README.md @@ -1,13 +1,5 @@ -# techdocs-cli +# TechDocs CLI -Welcome to the techdocs-cli plugin! +Check out the [TechDocs README](https://github.com/spotify/backstage/blob/master/plugins/techdocs/README.md) to learn more. -_This plugin was created through the Backstage CLI_ - -## 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 [/techdocs-cli](http://localhost:3000/techdocs-cli). - -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. +**WIP: This cli is a work in progress. It is not ready for use yet. Follow our progress on [the Backstage Discord](https://discord.gg/MUpMjP2) under #docs-like-code or on [our GitHub Milestone](https://github.com/spotify/backstage/milestone/15).**