Skip to content

Commit 08a93e9

Browse files
committed
chore(docs): update readme(add install, example, license, budges)
1 parent cf5cfdf commit 08a93e9

File tree

1 file changed

+42
-0
lines changed

1 file changed

+42
-0
lines changed

README.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,46 @@
11
# AWS Step Functions Execution Status Change Notification Stack
22

3+
[![GitHub](https://img.shields.io/github/license/gammarers/aws-stepfunctions-execution-status-change-notification-stack?style=flat-square)](https://github.com/gammarers/aws-stepfunctions-execution-status-change-notification-stack/blob/main/LICENSE)
4+
[![npm (scoped)](https://img.shields.io/npm/v/@gammarers/aws-stepfunctions-execution-status-change-notification-stack?style=flat-square)](https://www.npmjs.com/package/@gammarers/aws-stepfunctions-execution-status-change-notification-stack)
5+
[![GitHub Workflow Status (branch)](https://img.shields.io/github/actions/workflow/status/gammarers/aws-stepfunctions-execution-status-change-notification-stack/release.yml?branch=main&label=release&style=flat-square)](https://github.com/gammarers/aws-stepfunctions-execution-status-change-notification-stack/actions/workflows/release.yml)
6+
[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/gammarers/aws-stepfunctions-execution-status-change-notification-stack?sort=semver&style=flat-square)](https://github.com/gammarers/aws-stepfunctions-execution-status-change-notification-stack/releases)
7+
8+
[![View on Construct Hub](https://constructs.dev/badge?package=@gammarers/aws-stepfunctions-execution-status-change-notification-stack)](https://constructs.dev/packages/@gammarers/aws-stepfunctions-execution-status-change-notification-stack)
9+
310
This AWS CDK Stack retrieves the status of Step Functions via EventBridge and sends notifications accordingly. Currently, it only detects and notifies when the status of any machine is either "Failed" or "TimeOut."
411

12+
### TypeScript
13+
14+
#### install by npm
15+
16+
```shell
17+
npm install @gammarers/aws-stepfunctions-execution-status-change-notification-stack
18+
```
19+
20+
#### install by yarn
21+
22+
```shell
23+
yarn add @gammarers/aws-stepfunctions-execution-status-change-notification-stack
24+
```
25+
26+
## Example
27+
28+
### Code
29+
30+
```typescript
31+
import { RDSDatabaseAutoRunningProtectionStack } from '@gammarers/aws-stepfunctions-execution-status-change-notification-stack';
32+
33+
new StepFunctionsExecutionStatueChangeNotificationStack(app, 'StepFunctionsExecutionStatueChangeNotificationStack', {
34+
enableRule: true,
35+
notifications: {
36+
emails: [
37+
'foo@example.com',
38+
'bar@example.net',
39+
],
40+
},
41+
});
42+
```
43+
44+
## License
45+
46+
This project is licensed under the Apache-2.0 License.

0 commit comments

Comments
 (0)