diff --git a/README.md b/README.md new file mode 100644 index 0000000..7117e5c --- /dev/null +++ b/README.md @@ -0,0 +1,16 @@ +# Ribbon Order Lock + +Obsidian plugin that stops the left ribbon icons from reshuffling themselves. + +The plugin should work completely transparently, but it relies on undocumented +internals within Obsidian's `workspace.leftRibbon` object, so some future app +update could break it. Please open an issue if the ribbon ever stops behaving. + +## Install + +**BRAT**: `bdeshi/obsidian-ribbon-order-lock` + +**Manual**: extract the latest release archive inside +`.obsidian/plugins/ribbon-order-lock/`, and enable it. + +If you're using lazy-plugins, set this plugin's startup type to "Instant".