From 9719cdf6164b99cb2c4b07a3cd1477c5618ed143 Mon Sep 17 00:00:00 2001 From: James Struga Date: Thu, 5 Jan 2023 17:49:12 -0500 Subject: [PATCH] add some docs Signed-off-by: James Struga --- build/component/README.md | 19 +++++++++++++++++++ manifest.yaml | 2 +- 2 files changed, 20 insertions(+), 1 deletion(-) create mode 100644 build/component/README.md diff --git a/build/component/README.md b/build/component/README.md new file mode 100644 index 0000000..ab5e2e7 --- /dev/null +++ b/build/component/README.md @@ -0,0 +1,19 @@ +his program and the accompanying materials are +made available under the terms of the Eclipse Public License v2.0 which accompanies +this distribution, and is available at https://www.eclipse.org/legal/epl-v20.html + +SPDX-License-Identifier: EPL-2.0 + +Copyright Contributors to the Zowe Project. +# Sample Angular App + +This is an angular component that can be included in applications to be able to locate & browse the hierarchy of files and datasets on z/OS through the Zowe ZSS server APIs. Using the Zowe context menu, there is also a growing support of CRUD & other actions. + +**NOTE: Because this relies upon ZSS APIs, it must be used in an environment which handles session lifecycles, as you must log in to ZSS prior to using those APIs. One way to utilize this is to use this within a Zowe App, within the Zowe Desktop** + +## Installing +You must set the @zowe registry scope to get this library, as it is not yet on npmjs.org + +``` +npm config set @zowe:registry https://zowe.jfrog.io/zowe/api/npm/npm-release/ +zwe components install -c zowe.yaml --component (path or query) [--handler npm] [--registry https//localhost:1234/] [--dry-run] \ No newline at end of file diff --git a/manifest.yaml b/manifest.yaml index 4e5b780..40b7403 100644 --- a/manifest.yaml +++ b/manifest.yaml @@ -2,7 +2,7 @@ name: angular-sample id: org.zowe.zlux.sample.angular # Without the v -version: 2.0.1 +version: 2.6.0 # Human readable component name title: Angular Sample # Human readable component description