zowe-cli icon indicating copy to clipboard operation
zowe-cli copied to clipboard

Published 20 hours ago • verified publisher icon zowe

Eliminate duplication between readmes

Open t1m0thyj opened this issue 2 years ago • 0 comments

Currently there is a lot of overlap between the contents of the readme at the root of the repo (/README.md), and the readme for the Zowe CLI package (/packages/cli/README.md).

They have already fallen out of sync, with some changes made in just one file that should have been made in both.

I'm not sure exactly how the content should be split up, but believe we should update the readmes to contain distinct content geared to separate audiences. The readme at the root the repo has more visibility to CLI developers who find the CLI repository on GitHub, while the readme for the CLI package is shown to a wider audience on npmjs.com.

t1m0thyj avatar Oct 01 '21 14:10 t1m0thyj