doc: update readme to clarify usecase

This commit is contained in:
Dylan Armstrong 2025-04-04 15:48:23 +02:00
parent ed1489783c
commit 6fd55fa626
No known key found for this signature in database
GPG key ID: C574636C52BA5C5A

View file

@ -4,6 +4,10 @@ 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.
# Differences from Other Projects
Unlike [alexgavrusev/obsidian-format-with-prettier](https://github.com/alexgavrusev/obsidian-format-with-prettier), there's no configuration available. The common prettier settings, tabs and number of spaces are taken from the official settings under Editor.
# Installation
Unzip the [latest release](https://github.com/dylanarmstrong/obsidian-prettier-plugin/releases/latest) into `.obsidian/plugins` folder of your vault.