Skip to content

Commit

Permalink
readme updates
Browse files Browse the repository at this point in the history
  • Loading branch information
martzmakes committed May 15, 2023
1 parent b0e9b9c commit 63a0223
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# Architecture Aspect
# Architecture Diagram Aspect

This CDK Aspect traverse the tree to generate a GitHub / markdown compatible mermaid chart.
This CDK Aspect traverses the stack to generate a GitHub / markdown compatible mermaid chart of the AWS Resources created by the stack.

During each stack synthesis it will write a markdown file based on the stack's id. For example:
It outputs this as a markdown folder based on the stack's id. For example:

`new Stack(new App(), 'asdf');`

would create a markdown file called `asdf.md`.

On each subsequent synthesis, the Aspect will read the stack's existing markdown file (if it exists) and infer architecture changes b/w before and after.
On each subsequent synthesis, the Aspect will read the stack's existing markdown file (if it exists) and infer architecture changes b/w before and after. It will then replace the markdown file with a visual diff of the architecture (see examples below).

This uses no external dependencies!

Expand All @@ -18,7 +18,7 @@ This uses no external dependencies!
- Normal arrow lines indicate an existing linkage
- dashed/dotted arrow lines indicate a removed linkage

## Example - Simple Stack
## Example 1 - Simple Stack

```mermaid
graph LR;
Expand All @@ -28,7 +28,7 @@ classDef added fill:#cfc,stroke:#cfc,stroke-width:2px,color:black;
classDef removed fill:#fcc,stroke:#fcc,stroke-width:2px,color:black;
```

## Example - Queue Added to Stack
## Example 2 - Queue Added to Stack

```mermaid
graph LR;
Expand All @@ -40,7 +40,7 @@ classDef added fill:#cfc,stroke:#cfc,stroke-width:2px,color:black;
classDef removed fill:#fcc,stroke:#fcc,stroke-width:2px,color:black;
```

## Example - Stack re-synthed AFTER the queue was added
## Example 3 - Stack re-synthed AFTER the queue was added

```mermaid
graph LR;
Expand All @@ -52,7 +52,7 @@ classDef added fill:#cfc,stroke:#cfc,stroke-width:2px,color:black;
classDef removed fill:#fcc,stroke:#fcc,stroke-width:2px,color:black;
```

## Example - Queue Removed
## Example 4 - Queue Removed

```mermaid
graph LR;
Expand All @@ -64,7 +64,7 @@ classDef added fill:#cfc,stroke:#cfc,stroke-width:2px,color:black;
classDef removed fill:#fcc,stroke:#fcc,stroke-width:2px,color:black;
```

## Example - Stack re-synthed AFTER the queue was removed
## Example 5 - Stack re-synthed AFTER the queue was removed

```mermaid
graph LR;
Expand Down

0 comments on commit 63a0223

Please sign in to comment.