diff --git a/V4.md b/V4.md index 88215412..e8b82f62 100644 --- a/V4.md +++ b/V4.md @@ -6,12 +6,21 @@ V4 is a complete rewrite of the plugin. As a result: - Most features have been reimplimented with backwards-compatiable behaviour. - There are also some breaking changes (marked with "⚠️"). -## Fundamental Changes +## Usage + +You can start using V4 right now by installing it with the BRAT plugin + +> [!warning] Your Breadcrumbs settings will be migrated to the new format. +> Features that have already been reimplemented will retain their old settings. But missing features will lose their settings. + +## Changes + +### Foundational Changes - Nodes are added to the graph using their full path, not just their basename. This fixes issue: TODO - Implied relationships are customizable per-Hierarchy, not just globally. This resolves: TODO -## Features +### Features Legend: @@ -20,7 +29,7 @@ Legend: - ❌: Removed, don't plan to implement. - ❔: Undecided for now. -### Graph Builders +#### Graph Builders Previously referred to as "Alternative Hierarchies", these are the various ways to add edges to the Breadcrumbs graph. @@ -35,12 +44,12 @@ Previously referred to as "Alternative Hierarchies", these are the various ways - ❔ Regex notes - ❔ Traverse notes -### Commands +#### Commands - ✅ Create index from note (and copy to clipboard) - ⌚ Write Breadcrumbs to file -### Views +#### Views - ✅ Matrix view - ✅ Grid view @@ -51,15 +60,15 @@ Previously referred to as "Alternative Hierarchies", these are the various ways - ❔ Ducks view - ❔ Tree view -### Codeblocks +#### Codeblocks - ✅ Implemented -### API +#### API - ❔ Probably -## Breaking Changes ⚠️ +#### Breaking Changes ⚠️ - The `BC-tag-note` field is now called `BC-tag-note-tag`. - You will be notified if any notes use the old syntax, so you can change them.