v4.0.0 Documentation Update

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change Log
 
+2022_09_26 - v4.0.0
+*  Breaking: v10 of FoundryVTT introduced breaking changes to the underlying data model.
+*  Breaking: sbc v4.0.0+ will not work with FoundryVTT v9 or earlier
+*  Breaking: sbc v3.4.0 or earlier will not work with Foundry v10+
+*  Changed the data model used according to FoundryVTT v10, for a list of all changes, see [PR #595](https://github.com/Lavaeolous/PF1-StatBlock-Converter-Module/pull/595)
+
 2022_06_27 - v3.4.0
 *  Breaking: v0.81.0 of the PF1e system introduced a new attack / action system with is not compatible with version 3.3.6 or earlier of sbc!
 *  Added support for the new attack / action system (#544, #543, #542, #540, #539, #536, #535, #534)

README.md

@@ -11,11 +11,17 @@ Install the SBC Module via the Add-On Module Tab in FoundryVTT using the followi
 ```
 https://github.com/Lavaeolous/PF1-StatBlock-Converter-Module/releases/latest/download/module.json
 ```
-# Compatibility - SBC v3.4.0
+# Compatibility - SBC v4.0.0
 
-*  GameSystem: [PF1 0.81.0](https://gitlab.com/Furyspark/foundryvtt-pathfinder1)
-*  FoundryVTT: 9 Build 269
+*  GameSystem: [Pathfinder 1. Edition](https://gitlab.com/Furyspark/foundryvtt-pathfinder1),
+  *  Minimum: 0.82.2
+  *  Verified: 0.82.2
+*  FoundryVTT: Version 10
+  *  Minimum: 10
+  *  Verified: 10.286
 
+# Legacy Versions
+*  v4.0.0 of sbc is not compatible to v9 of FoundryVTT. Use release [v3.4.0](!https://github.com/Lavaeolous/PF1-StatBlock-Converter-Module/releases/tag/v3.4.0) for this.
 
 # How to Use
 1  Copy & Paste Statblocks into the input, you can edit the statblock after copying.
@@ -24,18 +30,17 @@ https://github.com/Lavaeolous/PF1-StatBlock-Converter-Module/releases/latest/dow
 
 # Disclaimer
 sbc is never finished it seems :D. See change log for latest updates and issues for known bugs.
-
 If you find any errors or have a statblock that can't be converted at all, feel free to open an issue here or let me know on the FoundryVTT Discord.
 
-# What gets converted
+# Please note
 *  The conversion from statblock text to actor is not perfect.
-*  To reproduce the statblock as written, some adjustments are added automatically.
-*  Statblocks often include typographical errors (e.g. extra linebreaks). You may need to fix these manually.
+*  To reproduce the statblock as written, some adjustments (e.g. through buffs or changes to attacks) are added automatically.
+*  Statblocks often include typographical errors (e.g. extra linebreaks) or ligatures (e.g. fi instead of fi). You may need to fix these manually.
 *  For important NPCs (e.g. named one's, bosses or the BBEG), check them manually after the conversion!
 *  Skills are almost never given in full in statblocks, sbc only fills in the ones given.
 
 # Known Bugs
-*  The transition to the new attack / action system in PF1e 0.81.0 is handled now by sbc, but may include some bugs. Let me know if you find any!
+*  This is the first FoundryVTT v10 compatible release, as such it may include (many) bugs
 *  Not all Statblocks are equally formatted. As long as its reasonably well formed, it should work. If not, check the preview area or console.
 *  See Issues. If you find anythings thats not noted there, please let me know.