diff --git a/README.md b/README.md index fa1a376..3626126 100644 --- a/README.md +++ b/README.md @@ -19,10 +19,11 @@ This repository contains a sample Zowe CLI Plug-in that adheres to the contribut This sample includes: - Source code for extending the Zowe CLI with a command that lists the contents of a remote directory. -- Tutorials on: +- Tutorials for: - [Building the plug-in](docs/tutorials/list-directory-contents/ListDirectoryContentsPlugin.md) to use its `zowe zowe-cli-sample list directory-contents` command. - [Enhancing the sample](docs/tutorials/files-util/FilesUtilPlugin.md) with a third-party package and creating a new command for file-diff highlighting. - [Augmenting the code](docs/tutorials/list-typicode-todo/ListTypicodeTodoPlugin.md) to connect with Typicode's external API, a simulator of backend data, to walk through the cli's interaction with RESTful services. + - [Using profiles](docs/tutorials/profile-example/ProfilePlugin.md) with your plug-in. - Examples of lifecycle hooks and GitHub Actions workflows for CICD. - Templates for unit, system and integration testing suites. @@ -67,7 +68,7 @@ Reference our [included GitHub Actions workflows](.github/workflows/) for guidan ### Initial Setup -To create your development space, you will clone and build zowe-cli-sample-plugin from source. +To create your development space, you will clone and build the zowe-cli-sample-plugin from source. Clone the repository into your development folder to match the following structure: ``` diff --git a/docs/tutorials/list-directory-contents/ListDirectoryContentsPlugin.md b/docs/tutorials/list-directory-contents/ListDirectoryContentsPlugin.md index 1c43751..c89b7cf 100644 --- a/docs/tutorials/list-directory-contents/ListDirectoryContentsPlugin.md +++ b/docs/tutorials/list-directory-contents/ListDirectoryContentsPlugin.md @@ -1,16 +1,17 @@ -# Installing the sample plug-in +# Using the sample plug-in -Before you begin, [setup](../Setup.md) your environment to install a plug-in. +(NOTE: This step may have completed during [setup](../Setup.md).) + +Before you begin, ensure you've completed the [initial setup](../../../README.md#initial-setup) of your environment to install a plug-in. ## Overview -This tutorial covers installing and running this bundled Zowe CLI Plug-in as-is (without modification), which will display your current directory contents. +This tutorial covers running this bundled Zowe CLI Plug-in as-is (without modification), which will display your current directory contents. The plug-in adds a command to the CLI that lists the contents of a directory on your PC. ## Installing the sample plug-in to Zowe CLI -(NOTE: This step may have completed during [setup](../Setup.md).) To begin, `cd` into your `zowe-tutorial` folder. diff --git a/src/index.ts b/src/index.ts index f13a76c..b0627c2 100644 --- a/src/index.ts +++ b/src/index.ts @@ -11,7 +11,7 @@ /** * Use the index.ts to export any public facing APIs/intefaces/etc. * - * If your plugin introduces a set of APIs/functions that others would find useful when building node apps + * If your plug-in introduces a set of APIs/functions that others would find useful when building node apps * (or editor extensions, etc.) export them here. * * For example, Zowe CLI offers Jobs APIs that can be invoke programmatically from a VS code extension to create