feat(inbox): Update readme

Author: m-szaf

README.md

@@ -1,108 +1,5 @@
-# deploy-beanstalk
+# cdk-log-parser
 
 [![codecov](https://codecov.io/gh/time-loop/deploy-beanstalk/branch/main/graph/badge.svg?token=oLuqCIiUqO)](https://codecov.io/gh/time-loop/deploy-beanstalk)
 
-`deploy-beanstalk` is a TypeScript library for deploying an artifact living in S3 to a group of AWS Elastic Beanstalk Environments.
-
-## Why?
-
-- **CI Tool Decoupling**
-  - The possibility of switching over to any CI tool (GitHub actions, GitLab CI, etc.) is attractive. To prep for that, we need portable scripts that can be run Anywhere™.
-  - CI scripts can be written in any language such that engineers can easily read and improve upon them.
-  - Consequently, we can easily introduce tests to our CI scripts.
-- **Parallel deployments**
-  - We can utilize language functionality (like TypeScript async functions, Golang goroutines, etc.) to allow for parallel deployments to multiple beanstalks at once...in whatever batched fashion we so desire.
-- **Build once, deploy many**
-  - The [TooManyApplicationVersions error](https://stackoverflow.com/questions/9589531/how-to-avoid-a-toomanyapplicationversion-exception-on-aws-elastic-beanstalk) is a nuisance and should be avoided. Indeed, it's a sign of bad build/deploy design which can potentially block deploys entirely. With `deploy-beanstalk`, no more than one Application Version is created per unique Beanstalk Application in the selected group, regardless of Environment count.
-
-## Usage
-
-`tools/ci/deploy/deploy.ts` handles asynchronous+simultaneous deployments to a group of beanstalk environments. It does this by creating an Application Version (one per Beanstalk Application only) from an artifact in S3 followed by issuing deployments of that Application Version to each respective beanstalk environment in the group.
-
-The library can be pulled from GitHub Packages.
-
-### Authentication
-
-> ***TL;DR:*** Follow the [abridged instructions](https://github.com/time-loop/cdk-library#setup-github-packages-access) written in cdk-library.
-
-You need to setup scoped access to GitHub Packages in your `~/.npmrc`. To do so, create a GitHub PAT with scope `read:packages`. With such a limited scope, setting expiry to `never` is permissible. Canonical instructions to do this can be [found here](https://docs.github.com/en/[email protected]/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).
-
-> NOTE: If you are working with a GitHub Workflow, the provided `GITHUB_TOKEN` might Just Work for you as this is a public package. However, if you also need to access packages that are private to your org, you might consider adding an `ALL_PACKAGE_READ_TOKEN` org secret followed by populating your .npmrc appropriately.
-
-After creating a PAT, follow [canonical instructions to setup your authentication to GitHub Packages](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-npm-registry).
-
-### Installation
-
-Use `npm` or any relevant package manager in your project like so:
-
-```bash
-# --save-dev is optional, depending on whether this is used in the main app or
-# a complementary tool like for CI/CD pipelines.
-npm install [--save-dev] @time-loop/deploy-beanstalk
-```
-
-### Importing
-
-```typescript
-import { 
-  deployToGroup, // function to call which deploys to a group
-  IBeanstalkGroup, // Allows us to dictate beanstalk environments to deploy to
-  IDeployToGroupProps // Rest of the configuration needed to deploy
-} from '@time-loop/deploy-beanstalk';
-```
-
-### Grouping
-
-An example configuration for a group of beanstalk environments and the artifact to deploy to them:
-
-```typescript
-const group: IBeanstalkGroup = {
-  environments: [
-    {
-      app: 'ClickupExampleAppOne',
-      name: 'ExampleEnvironmentOne',
-    },
-    {
-      app: 'ClickupExampleAppTwo',
-      name: 'ExampleEnvironmentTwo',
-    },
-  ],
-  versionProps: {
-    artifact: {
-      S3Bucket: 'example-bucket-clickup',
-      S3Key: 'exampleDir/clickupExampleArtifact.zip',
-    },
-    label: 'ExampleLabel',
-    description: 'Example desc',
-    errorIfExists: true,
-  },
-  name: 'ExampleBeanstalkGroup',
-  region: 'us-west-2',
-};
-```
-
-### Deploying
-
-```typescript
-try {
-    ...
-    const props: IDeployToGroupProps = {
-    group,
-    force: true,
-    // Allows 5 mins to verify health prior to deploy
-    preDeployHealthCheckProps: {
-      attempts: 5,
-      timeBetweenAttemptsMs: 60000,
-    },
-    // Allows 20 mins after deploy to verify health
-    postDeployHealthCheckProps: {
-      attempts: 20,
-      timeBetweenAttemptsMs: 60000,
-    },
-  };
-    await deployToGroup(props);
-} catch (e) {
-    console.error(e);
-    process.exit(1);
-}
-```
+`cdk-log-parser` is a TypeScript cli tool used for reducing cdk diff log output to only real changes.