Skip to content

Commit 9042461

Browse files
committed
update readme
1 parent 8f65fb2 commit 9042461

File tree

1 file changed

+23
-4
lines changed

1 file changed

+23
-4
lines changed

README.md

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,22 @@
11
# Obsidian Meta Bind Plugin
22

3-
This plugin can create input fields inside your notes and bind them to metadata fields, syncing their contents.
4-
Allowing you to create things like checkboxes inside your notes that change a metadata field e.g. `done` when checked.
5-
Or creating a slider inside your movie notes, that syncs up with a metadata field named `rating`.
3+
Meta Bind allows you to create input and view fields inside your notes.
4+
Those input and view fields can then be bound to frontmatter properties, which keeps them in sync those frontmatter properties.
5+
Allowing you to edit and view your frontmatter properties inside your notes.
6+
7+
For example, you can create a toggle inside your note, that is bound to a frontmatter property named `done`, with this simple inline code block `INPUT[toggle:done]`.
8+
When you click the toggle, the `done` property will switch between `true` and `false`.
9+
10+
To learn more, check out the [docs](https://mprojectscode.github.io/obsidian-meta-bind-plugin-docs).
611

712
### Demo
813

914
![](https://github.com/mProjectsCode/obsidian-meta-bind-plugin/raw/master/images/meta-bind-plugin-demo-3-gif.gif)
1015

1116
### Docs
1217

13-
The docs are available [here](https://mprojectscode.github.io/obsidian-meta-bind-plugin-docs).
18+
The docs for the plugin are available [here](https://mprojectscode.github.io/obsidian-meta-bind-plugin-docs).
19+
The plugin provides an offline FAQ/Help page as well, which can be accessed via a command or the plugins settings page.
1420

1521
### Problems, unexpected behavior or improvement suggestions?
1622

@@ -26,3 +32,16 @@ There is a setting to change the sync interval, but I don't recommend changing i
2632
Thank you for wanting to contribute to this project.
2733

2834
Contributions are always welcome. If you have an idea, feel free to open a feature request under the issue tab or even create a pull request.
35+
36+
#### Notes for Contributors
37+
38+
The plugin uses [Bun](https://bun.sh/) instead of Node.js/NPM to manage dependencies.
39+
To install the dependencies, run `bun install` in the root directory of the project.
40+
41+
- `bun run dev` will build the plugin in dev mode and watch for changes. The plugin builds directly into the example vault inside of this repo.
42+
- `bun run build` will build the plugin in production mode. The plugin builds into the root of this repo.
43+
- `bun run test` will run the tests.
44+
- `bun run check` will check for formatting, linting, type errors and run the tests.
45+
- `bun run check:fix` will fix formatting and linting errors, check for type errors and run the tests.
46+
47+
`bun run check` should run successfully before creating a pull request.

0 commit comments

Comments
 (0)