commit ceb3837850c1f6960446138f134aa12fa2b60ae3 parent ed0e0a6e90ba8a921d5db73606e6df7c26793de5 Author: Lishid <lishid@gmail.com> Date: Mon, 1 Mar 2021 12:59:44 -0500 Update README.md Diffstat:
| M | README.md | | | 10 | ++++++++++ |
1 file changed, 10 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md @@ -15,6 +15,16 @@ This sample plugin demonstrates some of the basic functionality the plugin API c - Registers a global click event and output 'click' to the console. - Registers a global interval which logs 'setInterval' to the console. +### First time developing plugins? + +Quick starting guide for new plugin devs: + +- Make a copy of this repo as a template with the "Use this template" button. +- Clone your repo to a local development folder. For convenience, you can place this folder in your `.obsidian/plugin/your-plugin-name` folder. +- Install NodeJS, then run `npm i` in the command line under your repo folder. +- Run `npm run dev` to compile your plugin from `main.ts` to `main.js`. +- Make changes to `main.ts` (or create new `.ts` files). Those changes should be automatically compiled into `main.js`. +- Reload Obsidian to load the new version of your plugin. ### Releasing new releases