Skip to content

Commit

Permalink
docs: Update README with link to demo.
Browse files Browse the repository at this point in the history
  • Loading branch information
sebastienfi committed Dec 29, 2023
1 parent 144b249 commit f54ae02
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

This GitHub Action automatically generates and updates Structurizr diagrams on pull requests. It's designed to simplify the process of keeping architecture diagrams up-to-date with the latest changes in your codebase.

-> [See this PR for a demo](https://github.com/sebastienfi/structurizr-github-actions-demo/pull/2).

## Prerequisites

Before you use this action, make sure you have:
Expand Down Expand Up @@ -34,6 +36,8 @@ jobs:
update-diagrams:
runs-on: ubuntu-latest
container: ghcr.io/sebastienfi/structurizr-cli-with-bonus:latest
permissions:
contents: write # Allow to work with the contents of the repository, including git push.
steps:
- uses: sebastienfi/structurizr-gen-images@v1
with:
Expand Down

0 comments on commit f54ae02

Please sign in to comment.