diff options
| author | lishid <[email protected]> | 2020-10-25 17:21:52 -0400 |
|---|---|---|
| committer | lishid <[email protected]> | 2020-10-25 18:45:40 -0400 |
| commit | dfd3fe233b6a7cf4bfe11d0644426fd09c381dd7 (patch) | |
| tree | eefe4c1d7efc5d319a68c1af92e41519048a8332 | |
| parent | ed3770792a7a9ce698999de42ebb6150f5ee5e9e (diff) | |
| download | ai-pulse-obsidian-plugin-dfd3fe233b6a7cf4bfe11d0644426fd09c381dd7.tar.gz ai-pulse-obsidian-plugin-dfd3fe233b6a7cf4bfe11d0644426fd09c381dd7.zip | |
Update documentation.
| -rw-r--r-- | README.md | 18 |
1 files changed, 13 insertions, 5 deletions
@@ -1,21 +1,29 @@ -### Obsidian Sample Plugin
+## Obsidian Sample Plugin
This is a sample plugin for Obsidian (https://obsidian.md).
This project uses Typescript to provide type checking and documentation.
-The repo contains the latest plugin API (obsidian.d.ts) in Typescript Definition format, which contains JSDoc comments describing what it does.
+The repo contains the latest plugin API (obsidian.d.ts) in Typescript Definition format, which contains TSDoc comments describing what it does.
-#### How to use
+**Note:** The Obsidian API is still in early alpha and is subject to change at any time!
+
+### Compatibility
+
+Custom plugins are only available for Obsidian v0.9.7+.
+
+The current API of this repo targets Obsidian **v0.9.7**.
+
+### How to use
- Clone this repo.
- `npm i` or `yarn` to install dependencies
- `npm run dev` to start compilation in watch mode.
-#### How to install the plugin
+### How to install the plugin
- Copy over `main.js`, `styles.css`, `manifest.json` to your vault `vault/.obsidian/plugins/plugin-id/`.
-#### Plugin structure
+### Plugin structure
`manifest.json`
|