Fix test groups and readme

.projenrc.js

@@ -6,7 +6,11 @@ const project = new awscdk.AwsCdkConstructLibrary({
   defaultReleaseBranch: 'main',
   name: 'aws-dynamodb-table-multi-gsis',
   repositoryUrl: 'https://github.com/flochaz/aws-dynamodb-table-multi-gsis.git',
-
+  jestOptions: {
+    jestConfig: {
+      runner: 'groups',
+    },
+  },
   cdkDependenciesAsDeps: false,
   cdkDependencies: ['@aws-cdk/aws-dynamodb', '@aws-cdk/custom-resources', '@aws-cdk/aws-iam'],
   cdkTestDependencies: ['@aws-cdk/aws-applicationautoscaling', '@aws-cdk/aws-kinesis', '@aws-cdk/aws-kms'],
@@ -29,9 +33,7 @@ const project = new awscdk.AwsCdkConstructLibrary({
 const e2e = project.addTask('test:e2e', {
   exec: 'jest --group=e2e',
 });
-const addJestGroupSupport = 'echo $(cat package.json | jq \'.jest.runner = "groups"\') > package.json';
-e2e.prependExec(addJestGroupSupport);
 
-project.testTask.reset(`${addJestGroupSupport} && jest --group=unit`);
+project.testTask.reset('jest --group=unit');
 
 project.synth();

README.md

@@ -1,4 +1,40 @@
 # @aws-cdk/aws-dynamodb + multi GSIs update capability
 
 
-This construct is fixing https://github.com/aws/aws-cdk/issues/12246 by simply overriding [@aws-cdk/aws-dynamodb Table addGlobalSecondaryIndex](https://github.com/aws/aws-cdk/blob/master/packages/%40aws-cdk/aws-dynamodb/lib/table.ts#L1231) which will leverage the [@aws-cdk/custom-resource Provider](https://docs.aws.amazon.com/cdk/api/v1/docs/custom-resources-readme.html) to sequentially create Global GSIs.
+This construct is fixing https://github.com/aws/aws-cdk/issues/12246 by simply overriding [@aws-cdk/aws-dynamodb Table addGlobalSecondaryIndex](https://github.com/aws/aws-cdk/blob/master/packages/%40aws-cdk/aws-dynamodb/lib/table.ts#L1231) which will leverage the [@aws-cdk/custom-resource Provider](https://docs.aws.amazon.com/cdk/api/v1/docs/custom-resources-readme.html) to sequentially create Global GSIs.
+
+## Usage
+
+Use `@aws-cdk/aws-dynamodb` as usual except for `Table` that needs to come from `aws-dynamodb-table-multi-gsis` :
+
+
+```typescript
+import { AttributeType, BillingMode } from '@aws-cdk/aws-dynamodb';
+import * as cdk from '@aws-cdk/core';
+
+// Import the new version of Table
+import { Table } from 'aws-dynamodb-table-multi-gsis';
+
+const app = new cdk.App();
+
+const stack = new cdk.Stack(app, 'integ-dynamodb-table');
+
+const testTable = new Table(stack, 'TestTable', {
+  partitionKey: { name: 'id', type: AttributeType.STRING },
+  billingMode: BillingMode.PAY_PER_REQUEST,
+});
+
+testTable.addGlobalSecondaryIndex({
+  indexName: 'global1',
+  partitionKey: { name: 'global1', type: AttributeType.STRING },
+});
+
+testTable.addGlobalSecondaryIndex({
+  indexName: 'global2',
+  partitionKey: { name: 'global2', type: AttributeType.STRING },
+});
+```
+
+## Potential caveat
+
+If the existing table already has GSIs, it will delete and recreates the GSIs ...