From 8ed1840f653621ad4af07b327e11bb70bb423b18 Mon Sep 17 00:00:00 2001 From: SebastianMC <23032356+SebastianMC@users.noreply.github.com> Date: Sun, 2 Jun 2024 00:45:54 +0200 Subject: [PATCH] README.md update - extracted the details of Obsidian breaking changes into dedicated files, leaving only informative frames --- README.md | 15 +++++---------- README.notice.for.Obsidian.1.5.4.md | 11 +++++++++++ README.notice.for.Obsidian.1.6.0.md | 10 ++++++++++ 3 files changed, 26 insertions(+), 10 deletions(-) create mode 100644 README.notice.for.Obsidian.1.5.4.md create mode 100644 README.notice.for.Obsidian.1.6.0.md diff --git a/README.md b/README.md index 8537587..143e268 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,10 @@ +> | :exclamation: Breaking changes in Obsidian 1.6.0 (and newer) - update the plugin to 2.1.9 or newer| +> |----------------------------------------------| +> |[More details](README.notice.for.Obsidian.1.6.0.md)| + > | :exclamation: Breaking changes in Obsidian 1.5.4 (and newer) - update the plugin to 2.1.7 or newer| > |----------------------------------------------| -> -> Obsidian team introduced some breaking changes in File Explorer in a not-backward-compatible way starting from Obsidian 1.5.4. -> -> The **custom sort** plugin starting from release **2.1.7** was adjusted to work correctly with these breaking changes in Obsidian 1.5.4 and newer. -> The plugin remains backward compatible, so you can safely update the plugin for Obsidian earlier that 1.5.4 -> -> For more details of the observed misbehavior (of not updated plugin) you can go to [#131](https://github.com/SebastianMC/obsidian-custom-sort/issues/131) or [#135](https://github.com/SebastianMC/obsidian-custom-sort/issues/135) or [#139](https://github.com/SebastianMC/obsidian-custom-sort/issues/139) -> -> | :exclamation: Breaking changes in Obsidian 1.5.4 (and newer) - update the plugin to 2.1.7 or newer| -> |----------------------------------------------| +> |[More details](README.notice.for.Obsidian.1.5.4.md)| --- diff --git a/README.notice.for.Obsidian.1.5.4.md b/README.notice.for.Obsidian.1.5.4.md new file mode 100644 index 0000000..274508a --- /dev/null +++ b/README.notice.for.Obsidian.1.5.4.md @@ -0,0 +1,11 @@ +> | :exclamation: Breaking changes in Obsidian 1.5.4 (and newer) - update the plugin to 2.1.7 or newer| +> |----------------------------------------------| +> +> Obsidian team introduced some breaking changes in File Explorer in a not-backward-compatible way starting from Obsidian 1.5.4. +> +> The **custom sort** plugin starting from release **2.1.7** was adjusted to work correctly with these breaking changes in Obsidian 1.5.4 and newer. +> The plugin remains backward compatible, so you can safely update the plugin for Obsidian earlier than 1.5.4 +> +> For more details of the observed misbehavior (of not updated plugin) you can go to [#131](https://github.com/SebastianMC/obsidian-custom-sort/issues/131) or [#135](https://github.com/SebastianMC/obsidian-custom-sort/issues/135) or [#139](https://github.com/SebastianMC/obsidian-custom-sort/issues/139) +> + diff --git a/README.notice.for.Obsidian.1.6.0.md b/README.notice.for.Obsidian.1.6.0.md new file mode 100644 index 0000000..57f6c81 --- /dev/null +++ b/README.notice.for.Obsidian.1.6.0.md @@ -0,0 +1,10 @@ +> | :exclamation: Breaking changes in Obsidian 1.6.0 (and newer) - update the plugin to 2.1.9 or newer| +> |----------------------------------------------| +> +> Obsidian team introduced some breaking changes in File Explorer sorting code in a not-backward-compatible way starting from Obsidian 1.6.0. +> +> The **custom sort** plugin starting from release **2.1.9** was adjusted to work correctly with these breaking changes in Obsidian 1.6.0 and newer. +> The plugin remains backward compatible, so you can safely update the plugin for Obsidian earlier than 1.6.0 +> +> For more details of the observed misbehavior (of not updated plugin) you can go to [#145](https://github.com/SebastianMC/obsidian-custom-sort/issues/145) +