Skip to content

Commit

Permalink
chore: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
seeebiii committed Jun 2, 2022
1 parent 0e78574 commit 3edd1c6
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ new VerifySesDomain(this, 'SesDomainVerification', {
#### Options

* `domainName` A domain name to be used for the SES domain identity, e.g. 'example.org'
* `hostedZoneName` A hosted zone name to be matched with a Route 53 record, e.g. 'example.org'. Default: use value of `domainName`.
* `hostedZoneName` A hosted zone name to be matched with a Route 53 record, e.g. 'example.org'. Default: same as `domainName`.
* `addTxtRecord` Whether to automatically add a TXT record to the hosed zone of your domain. This only works if your domain is managed by Route53. Otherwise disable it. Default: `true`.
* `addMxRecord` Whether to automatically add a MX record to the hosted zone of your domain. This only works if your domain is managed by Route53. Otherwise disable it. Default: `true`.
* `addDkimRecord` Whether to automatically add DKIM records to the hosted zone of your domain. This only works if your domain is managed by Route53. Otherwise disable it. Default: `true`.
Expand All @@ -81,11 +81,11 @@ Just open an issue or pull request :)

These commands should help you while developing:

* `npx projen` synthesize changes in [.projenrc.js](.projenrc.js) to the project
* `npm run build` compile typescript to js
* `npm run watch` watch for changes and compile
* `npm run test` perform the jest unit tests
* `npm run lint` validate code against best practices
* `npx projen` init [projen](https://github.com/projen/projen) and synthesize changes in [.projenrc.js](.projenrc.js) to the project
* `yarn build` compile typescript to js
* `yarn watch` watch for changes and compile
* `yarn test` perform the jest unit tests
* `yarn eslint` validate code against best practices

## Author

Expand Down

0 comments on commit 3edd1c6

Please sign in to comment.