Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
hupe1980 committed Jun 19, 2022
1 parent 052fab3 commit 3eb9688
Showing 1 changed file with 21 additions and 5 deletions.
26 changes: 21 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,10 @@ pip install cdktg
```

## How to use

### Threat Model written in typescript:
```typescript
const project = new Project({
outdir: 'dist',
});
const project = new Project();

const model = new Model(project, 'Model Stub', {
title: 'Model Stub',
Expand Down Expand Up @@ -81,7 +81,7 @@ const someOtherTechnicalAsset = new TechnicalAsset(model, 'Some Other Technical
humanUse: false,
size: Size.COMPONENT,
technology: Technology.WEB_SERVICE_REST,
tags: ["some-tag", "some-other-tag"],
tags: ['some-tag', 'some-other-tag'],
internet: false,
machine: Machine.VIRTUAL,
encryption: Encryption.NONE,
Expand Down Expand Up @@ -119,7 +119,8 @@ someSharedRuntime.run(someTechnicalAsset, someOtherTechnicalAsset);
project.synth();
```

```output
### cdktg CLI commands:
```sh
cdktg [command]

Commands:
Expand All @@ -134,6 +135,21 @@ Options:
--version Show version number [boolean]
```

### Analyse outputs:
```sh
dist
└── ModelStub
├── data-asset-diagram.png
├── data-flow-diagram.png
├── report.pdf
├── risks.json
├── risks.xlsx
├── stats.json
├── tags.xlsx
├── technical-assets.json
└── threagile.yaml
```

## Example

See more complete [examples](https://github.com/hupe1980/cdk-threagile-examples).
Expand Down

0 comments on commit 3eb9688

Please sign in to comment.