From 3d65611b90b936e48fa84c3d5079256219735d95 Mon Sep 17 00:00:00 2001 From: John Brunton Date: Sat, 17 Aug 2024 12:29:45 +0100 Subject: [PATCH] Update README.md --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index f339194c..112343f7 100644 --- a/README.md +++ b/README.md @@ -11,9 +11,8 @@ This project is an exercise in developing good clean architecture and CI/CD prac * A clean architecture, including dependency inversion enforced through linting rules with [eslint-plugin-boundaries](https://github.com/javierbrea/eslint-plugin-boundaries). * Separate domain, data and application boundaries in the application. Domain logic is completely separated from data access layers using [verified fake implementations](https://github.com/jbrunton/chat-demo/tree/main/services/api/src/data/repositories). * Continuous deployment pipelines to staging and production environments. -* Automatic documentation with [TypeDoc](https://typedoc.org/) deployed using GitHub Pages to [jbrunton.github.io/chat-demo](https://jbrunton.github.io/chat-demo/). +* Automatic documentation of code with [TypeDoc](https://typedoc.org/) deployed using GitHub Pages to [jbrunton.github.io/chat-demo](https://jbrunton.github.io/chat-demo/), and Open API docs deployed along with the api ([chat-demo-api.jbrunton-aws.com/docs](https://chat-demo-api.jbrunton-aws.com/docs)). * [ ] TODO: Automatic dependency updates (including automerging for minor version changes) with Renovate. -* [ ] TODO: OpenAPI Docs ## The demo application