From 91614362d6d9a19e92e0da17b38403cac79db93d Mon Sep 17 00:00:00 2001 From: Dylan Armstrong Date: Mon, 26 May 2025 20:58:13 +0200 Subject: [PATCH] doc: update readme --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 86caef7..40099df 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Obsidian Prettier Plugin -This is a formatting plugin for Obsidian (https://obsidian.md). +This is a formatting plugin for [Obsidian](https://obsidian.md). It uses the built-in settings for tabs and tab spacing so it doesn't require configuration. @@ -10,7 +10,9 @@ Unlike [alexgavrusev/obsidian-format-with-prettier](https://github.com/alexgavru # Installation -Unzip the [latest release](https://github.com/dylanarmstrong/obsidian-prettier-plugin/releases/latest) into `.obsidian/plugins` folder of your vault. +Install from community plugins. + +_Or_ unzip the [latest release](https://github.com/dylanarmstrong/obsidian-prettier-plugin/releases/latest) into `.obsidian/plugins` folder of your vault. # Usage @@ -24,7 +26,7 @@ This plugin only provides two options to prettier, namely tabWidth and useTabs. # Credits -Significant inspiration taken from [alexgavrusev/obsidian-format-with-prettier](https://github.com/alexgavrusev/obsidian-format-with-prettier). +Significant inspiration taken from [alexgavrusev/obsidian-format-with-prettier](https://github.com/alexgavrusev/obsidian-format-with-prettier) and [platers/obsidian-linter](https://github.com/platers/obsidian-linter). # License