diff --git a/API.md b/API.md
index c70bce8..aff4859 100644
--- a/API.md
+++ b/API.md
@@ -1,9 +1,3 @@
-
-
-🚧 **Work-in-Progress**: Breaking changes may occur at any given point during `v0.x`.
-
-
-
@@ -439,24 +433,24 @@ const project = new Project({
organization: 'Acme Corp',
name: 'Mad Scientists',
email: 'mad.scientists@acme.example.com',
- },
- defaultRegion: 'eu-west-1', // defaults to one of: $CDK_DEFAULT_REGION, $AWS_REGION or us-east-1
- accounts: {
- dev: {
- id: '111111111111',
- environments: ['development', 'feature/.*', 'staging'],
- config: {
- baseDomain: 'example.net',
- },
- },
- prod: {
- id: '222222222222',
- environments: ['production'],
- config: {
- baseDomain: 'example.com',
- },
- },
- },
+},
+defaultRegion: 'eu-west-1', // defaults to one of: $CDK_DEFAULT_REGION, $AWS_REGION or us-east-1
+accounts: {
+dev: {
+ id: '111111111111',
+ environments: ['development', 'feature/.*', 'staging'],
+ config: {
+ baseDomain: 'example.net',
+ },
+},
+prod: {
+ id: '222222222222',
+ environments: ['production'],
+ config: {
+ baseDomain: 'example.com',
+ },
+},
+},
})
```
@@ -2697,13 +2691,13 @@ AccountStrategy.one(props: AccountStrategyOneProps)
Enables single account strategy.
1. `shared` account with environments:
- - development
- - feature/*
- - test
- - qaN
- - staging
- - preproduction
- - production
+ - development
+ - feature/*
+ - test
+ - qaN
+ - staging
+ - preproduction
+ - production
*Example*
@@ -2733,15 +2727,15 @@ AccountStrategy.three(props: AccountStrategyThreeProps)
Enables triple account strategy.
1. `dev` account with environments:
- - development
- - feature/*
- - test
- - staging
+ - development
+ - feature/*
+ - test
+ - staging
2. `preprod` account with environments:
- - qaN
- - preproduction
+ - qaN
+ - preproduction
3. `prod` account with environments:
- - production
+ - production
*Example*
@@ -2777,14 +2771,14 @@ AccountStrategy.two(props: AccountStrategyTwoProps)
Enables dual account strategy.
1. `dev` account with environments:
- - development
- - feature/*
- - test
- - qaN
- - staging
+ - development
+ - feature/*
+ - test
+ - qaN
+ - staging
2. `prod` account with environments:
- - preproduction
- - production
+ - preproduction
+ - production
*Example*
@@ -3455,7 +3449,7 @@ new PathName()
| **Name** | **Description** |
| --- | --- |
-|
globally
| PascalCase naming with global prefixes (org, project…). |
+|
globally
| *No description.* |
|
it
| *No description.* |
|
withProject
| *No description.* |
@@ -3469,8 +3463,6 @@ import { PathName } from '@alma-cdk/project'
PathName.globally(scope: Construct, baseName: string, props?: NameProps)
```
-PascalCase naming with global prefixes (org, project…).
-
###### `scope`
Required
- *Type:* constructs.Construct
@@ -3767,7 +3759,7 @@ new UrlName()
| **Name** | **Description** |
| --- | --- |
-|
globally
| PascalCase naming with global prefixes (org, project…). |
+|
globally
| *No description.* |
|
it
| *No description.* |
|
withProject
| *No description.* |
@@ -3781,8 +3773,6 @@ import { UrlName } from '@alma-cdk/project'
UrlName.globally(scope: Construct, baseName: string, props?: NameProps)
```
-PascalCase naming with global prefixes (org, project…).
-
###### `scope`
Required
- *Type:* constructs.Construct