Merge branch 'metadata-lib'

Author: mProjectsCode

README.md

@@ -1,73 +1,22 @@
 # Obsidian Meta Bind Plugin
 
-This plugin can create input fields inside your notes and bind them to metadata fields.
+This plugin can create input fields inside your notes and bind them to metadata fields, syncing their contents.
+Allowing you to create things like checkboxes inside your notes that change a metadata field e.g. `done` when checked.
+Or creating a slider inside your movie notes, that syncs up with a metadata field named `rating`.
 
-### New docs
+### Demo
 
-I am currently working on new docs for this plugin.
-https://mprojectscode.github.io/obsidian-meta-bind-plugin-docs
+![](https://github.com/mProjectsCode/obsidian-meta-bind-plugin/tree/master/images/meta-bind-plugin-demo-3.mp4)
 
-### How to use
+### Docs
 
-To create an input field you have to write an inline code block or normal code block starting with `INPUT`. Then in square brackets the type of input field, in round brackets arguments and finally behind a colon the metadata field to bind to.
-
-#### Examples:
-
--   `INPUT[toggle]` will create an unbound toggle
--   `INPUT[slider:rating]` will create a slider bound to the metadata field `rating` of this note
--   `INPUT[text:task#completedOn]` will create a text input bound to the metadata field `completedOn` of the note with the name `task`
-
-The plugin also allows further customization with arguments. So the complete syntax looks like this:
-
-```
-INPUT[input_type(argument_name(argument_value), argument_name_2, ...):file_name_or_path#metadata_field]
-```
-
-For more examples see the `exampleVault` folder.
-
-#### Input field types
-
--   `slider` a slider from 0 to 100 (custom ranges can be set using `minValue` and `maxValue`, see below)
--   `toggle` a toggle element
--   `text` a text field
--   `text_area` a bigger text field
--   `select` a select input field, only for code blocks
--   `multi_select` a multi-select input field, only for code blocks
--   `date` a date input field
--   `date_picker` a date picker
-
-#### Arguments
-
--   `class(class_name)` adds a css class to the input field
--   `addLabels` only for slider, adds labels for the min and max values
--   `minValue(value)` only for slider, sets the min value
--   `maxValue(value)` only for slider, sets the max value
--   `option(value)` only for (multi-)selects, adds an option to the select
--   `title(value)` only for (multi-)selects, adds a title to the select input
--   `alignRight` only for date picker, aligns the date picker popup to the right of the input field
-
-### How to install
-
-You can eiter download it directly through Obsidian's plugin page or you can manually download the zip archive from the latest release here on GitHub.  
-After downloading, extract the archive into the `.obsidian/plugins` folder in your vault.
-
-The folder structure should look like this:
-
-```
-[path to your vault]
-|_ .obsidian
-   |_ plugins
-      |_ obsidian-meta-bind-plugin
-         |_ main.js
-         |_ manifest.json
-         |_ styles.css
-```
+The docs are available [here](https://mprojectscode.github.io/obsidian-meta-bind-plugin-docs).
 
 ### Problems, unexpected behavior or improvement suggestions?
 
 You are more than welcome to open an issue on [GitHub](https://github.com/mProjectsCode/obsidian-meta-bind-plugin/issues).
 
-#### The sync seems laggy
+#### The sync seems laggy / It takes half a second for the changes to sync
 
 This is intentional. To reduce the load on your hard drive the plugin ony syncs about 5 times a second.
 There is a setting to change the sync interval, but I don't recommend changing it.