From 1ed5923f104fbc9fa7975b46460b4bd730a9543a Mon Sep 17 00:00:00 2001 From: Dylan Armstrong Date: Fri, 4 Apr 2025 09:32:09 +0200 Subject: [PATCH] doc: update readme --- README.md | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index e3919c9..70e4ac2 100644 --- a/README.md +++ b/README.md @@ -6,10 +6,22 @@ It uses the built-in settings for tabs and tab spacing so it doesn't require con # Installation -# History +Unzip the [latest release](https://github.com/dylanarmstrong/obsidian-prettier-plugin/releases/latest) into `.obsidian/plugins` folder of your vault. -Inspired from [https://github.com/alexgavrusev/obsidian-format-with-prettier] with some code taken as well. +# Usage + +Format on save is enabled by default, and can be changed under plugin settings. + +Additionally, a "Format current file" command is available. + +# Customization + +This plugin only provides two options to prettier, namely tabWidth and useTabs. They are taken via the Editor settings. Beyond that, there's no customization provided. + +# Credits + +Significant inspiration taken from [alexgavrusev/obsidian-format-with-prettier](https://github.com/alexgavrusev/obsidian-format-with-prettier). # License -BSD Zero Clause License, for more details see [License](License.md) +BSD Zero Clause License, for more details see [License](./License.md)