Merge pull request #2 from aws-samples/fix/flags

Fixing NPM Module Install Instructions
aws-samples · Jan 24, 2024 · b40a328 · b40a328
2 parents 81d344e + d0b7e4a
commit b40a328
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 32 deletions.
diff --git a/README.md b/README.md
@@ -1,5 +1,5 @@
-AWS Sleek Transformer CLI
-=========================
+Addons Transformer CLI for Amazon EKS
+=====================================
 
 <!-- toc -->
 * [Usage](#usage)
@@ -38,31 +38,31 @@ To implement this solution, you need the following prerequisites:
 # Usage
 <!-- usage -->
 ```sh-session
-$ npm install -g aws-sleek-transformer
-$ aws-sleek-transformer COMMAND
+$ npm install -g addons-transformer-for-amazon-eks
+$ addons-transformer-for-amazon-eks COMMAND
 running command...
-$ aws-sleek-transformer (--version)
-aws-sleek-transformer/0.0.1 darwin-arm64 node-v20.10.0
-$ aws-sleek-transformer --help [COMMAND]
+$ addons-transformer-for-amazon-eks (--version)
+addons-transformer-for-amazon-eks/0.0.1 darwin-arm64 node-v20.8.0
+$ addons-transformer-for-amazon-eks --help [COMMAND]
 USAGE
-  $ aws-sleek-transformer COMMAND
+  $ addons-transformer-for-amazon-eks COMMAND
 ...
 ```
 <!-- usagestop -->
 # Commands
 <!-- commands -->
-* [`aws-sleek-transformer configure`](#aws-sleek-transformer-configure)
-* [`aws-sleek-transformer submit`](#aws-sleek-transformer-submit)
-* [`aws-sleek-transformer validate`](#aws-sleek-transformer-validate)
+* [`addons-transformer-for-amazon-eks configure`](#addons-transformer-for-amazon-eks-configure)
+* [`addons-transformer-for-amazon-eks submit`](#addons-transformer-for-amazon-eks-submit)
+* [`addons-transformer-for-amazon-eks validate`](#addons-transformer-for-amazon-eks-validate)
 
-## `aws-sleek-transformer configure`
+## `addons-transformer-for-amazon-eks configure`
 
 Sets up the Sleek CLI to work with a given helm chart
 
 ```
 USAGE
-  $ aws-sleek-transformer configure [--addonName <value>] [--addonVersion <value>] [--helmUrl <value>]
-    [--marketplaceId <value>] [--namespace <value>] [--region <value>]
+  $ addons-transformer-for-amazon-eks configure [--addonName <value>] [--addonVersion <value>] [--helmUrl
+    <value>] [--marketplaceId <value>] [--namespace <value>] [--region <value>]
 
 FLAGS
   --addonName=<value>      Name of the addon
@@ -101,18 +101,18 @@ DESCRIPTION
 
 
 EXAMPLES
-  $ aws-sleek-transformer configure
+  $ addons-transformer-for-amazon-eks configure
 ```
 
-_See code: [src/commands/configure.ts](https://github.com/elaramas/aws-sleek-transformer/blob/v0.0.1/src/commands/configure.ts)_
+_See code: [src/commands/configure.ts](https://github.com/aws-samples/addons-transformer-for-amazon-eks/blob/v0.0.1/src/commands/configure.ts)_
 
-## `aws-sleek-transformer submit`
+## `addons-transformer-for-amazon-eks submit`
 
 Uses the pre-existing configurations to submit the addon to the AWS marketplace
 
 ```
 USAGE
-  $ aws-sleek-transformer submit [--addonName <value>] [--addonVersion <value>]
+  $ addons-transformer-for-amazon-eks submit [--addonName <value>] [--addonVersion <value>]
 
 FLAGS
   --addonName=<value>     Name of the addon to submit
@@ -139,18 +139,18 @@ DESCRIPTION
 
 
 EXAMPLES
-  $ aws-sleek-transformer submit
+  $ addons-transformer-for-amazon-eks submit
 ```
 
-_See code: [src/commands/submit.ts](https://github.com/elaramas/aws-sleek-transformer/blob/v0.0.1/src/commands/submit.ts)_
+_See code: [src/commands/submit.ts](https://github.com/aws-samples/addons-transformer-for-amazon-eks/blob/v0.0.1/src/commands/submit.ts)_
 
-## `aws-sleek-transformer validate`
+## `addons-transformer-for-amazon-eks validate`
 
 Validates a given addon from the configuration provided through the 'configure' command
 
 ```
 USAGE
-  $ aws-sleek-transformer validate [--addonName <value>] [--addonVersion <value>]
+  $ addons-transformer-for-amazon-eks validate [--addonName <value>] [--addonVersion <value>]
 
 FLAGS
   --addonName=<value>     Name of the addon to validate
@@ -176,8 +176,8 @@ DESCRIPTION
 
 
 EXAMPLES
-  $ aws-sleek-transformer validate
+  $ addons-transformer-for-amazon-eks validate
 ```
 
-_See code: [src/commands/validate.ts](https://github.com/elaramas/aws-sleek-transformer/blob/v0.0.1/src/commands/validate.ts)_
+_See code: [src/commands/validate.ts](https://github.com/aws-samples/addons-transformer-for-amazon-eks/blob/v0.0.1/src/commands/validate.ts)_
 <!-- commandsstop -->
diff --git a/package.json b/package.json
@@ -1,13 +1,12 @@
 {
-  "author": "Shardul Vaidya @5herlocked",
+  "author": "Elamaran Shanmugam @elamaras",
   "bin": "./bin/run.js",
   "dependencies": {
     "@aws-sdk/client-sts": "^3.462.0",
     "@inquirer/prompts": "^3.3.0",
     "@inquirer/select": "^1.3.1",
     "@oclif/core": "^3",
     "@oclif/plugin-help": "^5",
-    "aws-sleek-transformer": "file:aws-sleek-transformer-0.0.1.tgz",
     "oclif": "^4.0.3",
     "shx": "^0.3.4"
   },
@@ -37,13 +36,13 @@
     "/dist",
     "/oclif.manifest.json"
   ],
-  "homepage": "https://github.com/elaramas/aws-sleek-transformer",
+  "homepage": "https://github.com/aws-samples/addons-transformer-for-amazon-eks.git",
   "main": "",
   "license": "MIT",
-  "name": "aws-sleek-transformer",
+  "name": "addons-transformer-for-amazon-eks",
   "oclif": {
-    "bin": "aws-sleek-transformer",
-    "dirname": "aws-sleek-transformer",
+    "bin": "addons-transformer-for-amazon-eks",
+    "dirname": "addons-transformer-for-amazon-eks",
     "commands": "./dist/commands",
     "topicSeparator": " ",
     "macos": {
@@ -61,7 +60,7 @@
       }
     }
   },
-  "repository": "elaramas/aws-sleek-transformer",
+  "repository": "aws-samples/addons-transformer-for-amazon-eks",
   "scripts": {
     "build": "shx rm -rf dist && tsc -b",
     "lint": "eslint . --ext .ts",
@@ -72,7 +71,7 @@
     "version": "oclif readme && git add README.md"
   },
   "version": "0.0.1",
-  "bugs": "https://github.com/elaramas/aws-sleek-transformer/issues",
+  "bugs": "https://github.com/aws-samples/addons-transformer-for-amazon-eks/issues",
   "keywords": [
     "oclif"
   ],