From 96d8e89b35cb2a499c8a75380a1432f7bfa1fcb0 Mon Sep 17 00:00:00 2001 From: Paul Robert Lloyd Date: Tue, 28 Jun 2022 14:56:40 +0100 Subject: [PATCH] Readme API link (#698) * Use correct repo name in README * README Markdown tweaks --- README.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 257b1bd22..b9d4ea810 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # Submit social housing lettings and sales data (CORE) -[![Production CI/CD Pipeline](https://github.com/communitiesuk/mhclg-data-collection-beta/actions/workflows/production_pipeline.yml/badge.svg)](https://github.com/communitiesuk/mhclg-data-collection-beta/actions/workflows/production_pipeline.yml) -[![Staging CI/CD Pipeline](https://github.com/communitiesuk/mhclg-data-collection-beta/actions/workflows/staging_pipeline.yml/badge.svg)](https://github.com/communitiesuk/mhclg-data-collection-beta/actions/workflows/staging_pipeline.yml) +[![Production CI/CD Pipeline](https://github.com/communitiesuk/submit-social-housing-lettings-and-sales-data/actions/workflows/production_pipeline.yml/badge.svg)](https://github.com/communitiesuk/submit-social-housing-lettings-and-sales-data/actions/workflows/production_pipeline.yml) +[![Staging CI/CD Pipeline](https://github.com/communitiesuk/submit-social-housing-lettings-and-sales-data/actions/workflows/staging_pipeline.yml/badge.svg)](https://github.com/communitiesuk/submit-social-housing-lettings-and-sales-data/actions/workflows/staging_pipeline.yml) Ruby on Rails app that handles the submission of lettings and sales of social housing data in England. Currently in private beta. @@ -25,11 +25,12 @@ Ruby on Rails app that handles the submission of lettings and sales of social ho ## API documentation -API documentation can be found here: . This is driven by [OpenAPI docs](docs/api/DLUHC-CORE-Data.v1.json) - +API documentation can be found here: . This is driven by [OpenAPI docs](docs/api/DLUHC-CORE-Data.v1.json) ## System architecture + ![View of system architecture](docs/images/architecture.png) -## UI: +## User interface + ![View of the logs list](docs/images/logs_list.png)