Updated readme

README.md

@@ -1,60 +1,13 @@
-# ssp-eks-extension
-Supplemental repository that shows how to create extensions for https://github.com/aws-quickstart/ssp-amazon-eks
+# rezilion-ssp-addon
 
-# Prerequisites
+Rezilion SSP addon allows you to integrate Rezilion instrumentation into your K8s cluster.
 
-Instructions are provided for MacOS. For Linux and Windows please consult documentation how to install the required components (`make`, `nodejs`). Please consider contributing to this guide.
+# Instrumentation
+The Rezilion instrumentation integrated with your K8s cluster by adding a daemon set to it that ensures every node
+in your cluster includes a pod with our agent.
 
-1. Install Make on Mac.
-```
-$ sudo brew install make
-```
-2. Install Node.js.
-```
-$ sudo brew install node
-```
+The agent scans the containers inside the pods on the node and collects required information for Rezilion Validate.
 
-Make sure that the installed Node.js version is compatible with CDK. More information can be found [here](https://docs.aws.amazon.com/cdk/latest/guide/getting_started.html#:~:text=All%20AWS%20CDK,a%20different%20recommendation.) (scroll to the "Prerequisites" section).
-
-3. Install [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html) and provide credentials by running `aws configure`. 
-
-4. In order to avoid problems with CDK version potentially being different from the version used by the AWS SSP for EKS create a local alias for CDK (as opposed to system wide installation). For that include the following alias to your ~/.bashrc or ~/.zshrc file:
-
-```
-alias cdk="npx cdk"
-```
-Make sure you run `source ~/.bashrc` after editing the file. 
-
-Example for mac/linux terminal:
-
-```
-$ echo 'alias cdk="npx cdk"' >> ~/.zshrc
-$ source ~/.zshrc
-```
-
-5. Clone this git repository
-```
-git clone https://github.com/shapirov103/ssp-eks-extension.git
-cd ssp-eks-extension
-```
-
-6. Modify package.json and provide your name for the package including your organization. Example:
-```
-"name": "@mycompany/ssp-addon-myproduct"
-``` 
-Where 'myproduct' should be replaced with the name of your product. 
-
-7. Apply other dependencies to the package.json and make sure that the CDK version used in the file is the one that is used by the SSP EKS Quickstart, which can be looked up on the [Getting Started Page](https://github.com/aws-quickstart/ssp-amazon-eks#getting-started) or directly in the [package.json](https://github.com/aws-quickstart/ssp-amazon-eks/blob/main/package.json).
-
-8.  Run `npm i`.
-
-9. Apply changes to `lib/index.ts` to implement your add-on. Note. the quickstart provides convenience base class `HelmAddOn` for add-ons that leverage a helm chart. It has a few advantages, including ability to use GitOps for add-on management.
-
-10. Apply changes to `bin/main.ts` to test your add-on.
-
-11. Run `make build`, `make lint`, `cdk list` to build. 
-12. Run `cdk deploy` to test the blueprint with deployment to AWS.
-13. Use Jest test framework for any unit tests.
-14. Run `npm publish` to publish your add-on to npm. 
-15. Create documentation, populate README on the repo. 
-16. Create an example pattern and documentation that could be submitted to https://github.com/aws-samples/ssp-eks-patterns
+# Requirements
+To use the addon you need to register with Rezilion at www.rezilion.com to get an API key for the Rezilion Validate 
+service.

package.json

@@ -1,11 +1,8 @@
 {
-  "name": "rezilion-ssp-addon",
-  "version": "0.1.0",
+  "name": "@rezilion/rezilion-ssp-addon",
+  "version": "0.0.1",
   "main": "dist/lib/index.js",
   "types": "dist/lib/index.d.ts",
-  "bin": {
-    "eks-ssp-patterns": "dist/bin/main.js"
-  },
   "scripts": {
     "build": "rm -rf dist && tsc",
     "watch": "tsc -w",
@@ -31,5 +28,25 @@
     "@aws-cdk/core": "1.135.0",
     "@aws-quickstart/ssp-amazon-eks": "^0.12.4",
     "source-map-support": "^0.5.16"
-  }
+  },
+  "description": "Rezilion SSP Addon",
+  "directories": {
+    "lib": "lib"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Rezilion/rezilion-ssp-addon.git"
+  },
+  "keywords": [
+    "Rezilion",
+    "Validate",
+    "SSP",
+    "EKS"
+  ],
+  "author": "Rezilion",
+  "license": "UNLICENSED",
+  "bugs": {
+    "url": "https://github.com/Rezilion/rezilion-ssp-addon/issues"
+  },
+  "homepage": "https://github.com/Rezilion/rezilion-ssp-addon#readme"
 }