From ac25caeb2c38664388266fd14b0a01c860ad43c0 Mon Sep 17 00:00:00 2001 From: elenakrittik Date: Fri, 22 Sep 2023 20:17:38 +0300 Subject: [PATCH] misc(readme): Add Godot version support notice. --- CHANGELOG.md | 29 +++++++++++++++++++++++++++++ README.md | 2 ++ 2 files changed, 31 insertions(+) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..86640ed --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,29 @@ +# v1.0.0 -> v2.0.0 + +## Breaking Changes + +- `XMLNodeType` was removed due to not being used anywhere. +- `beautify` parameter in all `XML.dump_*()` functions was renamed to `pretty`. +- Move `XMLDocument.to_dict()` to `XMLNode.to_dict()`. +- Make `XMLNode.to_dict()` opinionated by removing all controllability functions. +- Change structure of `XMLNode.to_dict()`'s output. + +## Features + +- `XML` can now handle semantically invalid XML. +- Added `indent_level` and `indent_length` to control initial indentation level and level width respectively. +- Allow accessing `XMLNode` children by their name if their name is unqiue amongst that `XMLNode`'s children. Works in the editor too. +- Document structure of `XMLNode.to_dict()`'s output. + +## Bug Fixes + +- Fix empty standalone nodes geting two spaces before `>` when prettified. +- Fix node content being on the same line as it's node when prettified. + +## Internal Changes + +- Remove pointless checks in parsing logic. +- Properly document code to make contributing easier. +- Reformat code to use 4-space indent instead of the previous tabs. +- Remove commented out code in some places. +- Refactor prettifier and dictionary converter to be recursive-descent, significantly simplifying logic. diff --git a/README.md b/README.md index 345e5a6..af9d7b0 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,8 @@ This addon adds support for manipulating XML data in Godot 4 with ease. +> Supports Godot 4.0, 4.1 and the likely the upcoming 4.2. + > HINT: Migrating from v1? See [changelog](./CHANGELOG.md) for a complete list of breaking (and not) changes. ## Features