Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Krzysztof Reczek authored Apr 27, 2022
1 parent da7a02b commit 9e65c33
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
# go-structurizr
This library allows you to auto-generate C4 component diagrams out from the Golang code.

## Exemplary output:
![Example](images/example.png)

## Usage and examples
If you want to get directly into usage of the library check my [blog post](https://threedots.tech/post/auto-generated-c4-architecture-diagrams-in-go/) with a step-by-step implementation guide.

You may also find a couple of examples implemented in the `cmd` directory. In order to run any of those examples, please run the shell script attached.

## How it works?
The library provides a set of tools (Scraper and View) that allow you to scrape and render given Golang structures into a [C4 component](https://c4model.com/) diagram in [*.plantuml](https://plantuml.com/) format.

Expand Down Expand Up @@ -192,9 +196,6 @@ err = v.RenderStructureTo(structure, outFile)
## Debug mode
In order to see detailed scraping or view rendering logs, set `LOG_LEVEL` env variable with `debug` of `DEBUG`.

## Examples
You may find a couple of examples implemented in the `cmd` directory. In order to run any of those examples, please run the shell script attached.

## Good practices
The best results and experience in using the library will be ensured by enforcing the following practices:
- Having a solid and well-organized application context following clean-architecture principles will make your diagrams simple and easy to read. Also, this will allow you to create a short list of component types and styles.
Expand Down

0 comments on commit 9e65c33

Please sign in to comment.