diff --git a/.projenrc.ts b/.projenrc.ts index cc941af..1049420 100644 --- a/.projenrc.ts +++ b/.projenrc.ts @@ -1,14 +1,14 @@ -import { CdklabsConstructLibrary } from "cdklabs-projen-project-types"; +import { CdklabsConstructLibrary } from 'cdklabs-projen-project-types'; const project = new CdklabsConstructLibrary({ - author: "AWS", - authorAddress: "aws-cdk-dev@amazon.com", - cdkVersion: "2.1.0", - defaultReleaseBranch: "main", - devDeps: ["cdklabs-projen-project-types"], - name: "aws-lambda-rust", + author: 'AWS', + authorAddress: 'aws-cdk-dev@amazon.com', + cdkVersion: '2.1.0', + defaultReleaseBranch: 'main', + devDeps: ['cdklabs-projen-project-types'], + name: 'aws-lambda-rust', projenrcTs: true, release: false, - repositoryUrl: "https://github.com/cdklabs/aws-lambda-rust.git", + repositoryUrl: 'https://github.com/cdklabs/aws-lambda-rust.git', // deps: [], /* Runtime dependencies of this module. */ // description: undefined, /* The description is just a string that helps people understand the purpose of the package. */ diff --git a/API.md b/API.md new file mode 100644 index 0000000..9a15d7b --- /dev/null +++ b/API.md @@ -0,0 +1,39 @@ +# API Reference + + + +## Classes + +### Hello + +#### Initializers + +```typescript +import { Hello } from 'aws-lambda-rust' + +new Hello() +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| sayHello | *No description.* | + +--- + +##### `sayHello` + +```typescript +public sayHello(): string +``` + + + + +