Skip to content

Commit

Permalink
Update READMEs.
Browse files Browse the repository at this point in the history
  • Loading branch information
simonbrowndotje committed Jan 9, 2024
1 parent 3e63fb8 commit 4e7e075
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 2 deletions.
8 changes: 7 additions & 1 deletion structurizr-client/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,10 @@

[![Maven Central](https://img.shields.io/maven-central/v/com.structurizr/structurizr-client.svg?label=Maven%20Central)](https://search.maven.org/artifact/com.structurizr/structurizr-client)

- [Documentation](https://docs.structurizr.com/java/workspace-api)
This library provides an API client for the workspace and admin APIs provided by the Structurizr cloud service and on-premises installation.

- [Cloud service - Workspace API](https://docs.structurizr.com/cloud/workspace-api)
- [Cloud service - Admin API](https://docs.structurizr.com/cloud/admin-api)
- [On-premises installation - Workspace API](https://docs.structurizr.com/onpremises/workspace-api)
- [On-premises installation - Admin API](https://docs.structurizr.com/onpremises/admin-api)
- [Workspace API client](https://docs.structurizr.com/java/workspace-api)
2 changes: 2 additions & 0 deletions structurizr-core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,7 @@

[![Maven Central](https://img.shields.io/maven-central/v/com.structurizr/structurizr-core.svg?label=Maven%20Central)](https://search.maven.org/artifact/com.structurizr/structurizr-core)

This library provides the core functionality of Structurizr related to creating workspaces.

- [Documentation](https://docs.structurizr.com/java)

2 changes: 1 addition & 1 deletion structurizr-dsl/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[![Maven Central](https://img.shields.io/maven-central/v/com.structurizr/structurizr-dsl.svg?label=Maven%20Central)](https://search.maven.org/artifact/com.structurizr/structurizr-dsl)

This GitHub repository contains an implementation of the Structurizr DSL - a way to create Structurizr software
This library is the implementation of the Structurizr DSL - a way to create Structurizr software
architecture models based upon the [C4 model](https://c4model.com) using a textual domain specific language (DSL).
The Structurizr DSL has appeared on the
[ThoughtWorks Tech Radar - Techniques - Diagrams as code](https://www.thoughtworks.com/radar/techniques/diagrams-as-code)
Expand Down

0 comments on commit 4e7e075

Please sign in to comment.