Feat: Update Readme

This commit is contained in:
Daniel Bauer
2024-12-19 13:36:27 +01:00
committed by GitHub
parent 5802a6cd5d
commit 910d343948

View File

@@ -3,10 +3,24 @@
This is a plugin for Obsidian (https://obsidian.md).
Obsidian Dataview Autocomplete enhances the functionality of the popular [Dataview plugin](https://github.com/blacksmithgu/obsidian-dataview)
by providing autocomplete suggestions for metadata fields in the editor.
by providing autocomplete suggestions for metadata fields in the editor. This makes it easy to reuse existing fields and reduced typing errors.
![Demo](./assets/demo.gif)
## Features
- Provides autocomplete suggestions for inline metadata fields used by Dataview.
- Customizable ignored fields and files for suggestions.
## Installation
While plugin is [waiting](https://github.com/obsidianmd/obsidian-releases/pull/4913) to be reviewed and added to the community plugin list, you can install it manually following the steps below:
1. Download the latest release from the Releases page.
2. Create a folder named "dataview-autocompletion" in the Obsidian plugins folder (.obsidian/plugins).
3. Extract the release file into the new folder.
4. Enable the plugin in the Obsidian settings under the "Community plugins" section. You might have to restart Obsidian to rsee the plugin.
## License
This project is licensed under the **MIT** License. See [LICENSE](./LICENSE)