From e1f6efba2e1d156d3d2860b92d9c04fd824a2d8f Mon Sep 17 00:00:00 2001
From: Dan Jones <danjon@noc.ac.uk>
Date: Thu, 22 Aug 2024 09:58:47 +0100
Subject: [PATCH] docs: update README and CHANGELOG

---
 CHANGELOG.md | 9 +++++++--
 README.md    | 6 ++----
 2 files changed, 9 insertions(+), 6 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index ab6df79..5ca1898 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+### Changed
+
+- Updated README to run tests against JS dependencies
+
 ## [v0.2.0] - 2024-02-06 
 
 ### Added 
@@ -15,9 +19,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - Emergency flag in mission plan schemas
 - Added additional battery and fuel fields to platform status for SPINE project 
 
-### Changed
+### Changed 
 
-- Updated README to run tests against JS dependencies
+- Refactor schema script to remove invalid definitions object automatically
+- Refactor generate_schema_config script to output file on -f flag 
 
 ## [v0.1.0] - 2023-03-24
 
diff --git a/README.md b/README.md
index 4d3b970..1588222 100644
--- a/README.md
+++ b/README.md
@@ -72,12 +72,10 @@ eg
 ## Run Docs & Save Schema When Updating Message Formats
 1. Run the command below and go to `http://127.0.0.1:5000`
 ```
-python3 generate_schema_config.py
+python3 generate_schema_config.py -f 
 ```
 
-2. Copy the schema generated `http://127.0.0.1:5000/soar_protocol.json` into the `backbone-message-format/project/<project_name>/swagger.json`
-
-3. In the json copied, remove the key `"definitions"` from the schema and save this.
+2. Commit any changes to the `backbone-message-format/project/<project_name>/swagger.json`
 
 ## Run Tests
 Run both tests below:
-- 
GitLab