From 02ec84905ac9b68399fbea2a1319bed76cf539c5 Mon Sep 17 00:00:00 2001 From: Cleon <18450687+meld-cp@users.noreply.github.com> Date: Fri, 6 Jan 2023 17:29:58 +1300 Subject: [PATCH] docs --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index 059398f..724db00 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,24 @@ Write and execute JavaScript in code blocks to render templates, query DataView and create dynamic notes. +Basically, turn a note into a small, simple, runnable thing. + +## Quick Start +- Install and enable the plugin +- Paste the Markdown below into a new note. +- If you are in Reading or Live Preview modes, click the 'Hi' button. If you are in Source mode, choose `Meld Build: Run` from the command pallette. +````md + +```meld-build-toolbar +run = Hi +``` + +```js meld-build +const ans = await $.ui.ask('What should I call you?'); +await $.ui.message( `From this day forth you shall be known as ${ans}` ); +``` +```` + ## Documentaion - [User Guide](/docs/user-guide.md)