Skip to content
This repository was archived by the owner on Mar 28, 2026. It is now read-only.

Commit 0dbfce7

Browse files
Some readme tweaks.
1 parent 6e02d52 commit 0dbfce7

5 files changed

Lines changed: 5 additions & 6 deletions

File tree

README.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,12 @@
22

33
# Structurizr for Java
44

5-
This GitHub repository is an official client library for the [Structurizr](https://structurizr.com) cloud service and on-premises installation, both of which are web-based publishing platforms for software architecture models based upon the [C4 model](https://c4model.com). The component finder, adr-tools importer, and alternative diagram export formats (e.g. PlantUML) can be found at [Structurizr for Java extensions](https://github.com/structurizr/java-extensions).
5+
This GitHub repository is (1) a client library for the [Structurizr](https://structurizr.com) cloud service and on-premises installation
6+
and (2) a way to create a Structurizr workspace using Java code. Looking for the [Structurizr DSL](https://github.com/structurizr/dsl) instead?
67

78
## A quick example
89

9-
As an example, the following Java code can be used to create a software architecture __model__ and an associated __view__ that describes a user using a software system.
10+
As an example, the following Java code can be used to create a software architecture __model__ and an associated __view__ that describes a user using a software system, based upon the [C4 model](https://c4model.com).
1011

1112
```java
1213
public static void main(String[] args) throws Exception {
@@ -24,10 +25,8 @@ public static void main(String[] args) throws Exception {
2425
}
2526
```
2627

27-
The view can then be exported to be visualised using the [Structurizr cloud service/on-premises installation](https://structurizr.com),
28-
or other formats including PlantUML, Mermaid, and WebSequenceDiagrams via the [structurizr-export library](https://github.com/structurizr/export).
29-
30-
![Views can be exported and visualised via a number of tools](docs/images/readme-1.png)
28+
The view can then be exported to be visualised using the [Structurizr cloud service/on-premises installation/Lite](https://structurizr.com),
29+
or other formats including PlantUML, Mermaid, DOT, and WebSequenceDiagrams via the [structurizr-export library](https://github.com/structurizr/export).
3130

3231
## Table of contents
3332

docs/images/documentation-1.png

-600 KB
Binary file not shown.

docs/images/documentation-2.png

-530 KB
Binary file not shown.

docs/images/documentation-3.png

-404 KB
Binary file not shown.

docs/images/readme-1.png

-82.4 KB
Binary file not shown.

0 commit comments

Comments
 (0)