From 8218429ad40666177a90e0d1de15e099c99b38b3 Mon Sep 17 00:00:00 2001 From: Zef Hemel Date: Sat, 15 Oct 2022 20:23:55 +0200 Subject: [PATCH] Updated README --- README.md | 37 +++++++++++++++++++++++++++++++------ 1 file changed, 31 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 8bc89ae..bb240bb 100644 --- a/README.md +++ b/README.md @@ -9,15 +9,40 @@ If you don't know what it is, check its [webpage](https://silverbullet.md), but you want me to spoil the fun: it is an extensible note taking app with markdown and plain files at its core (well... there is a bit of magic in there too, but what good it would be without a little magic?) -## Installation +## Build +To build this plug, make sure you have `plugos-bundle` installed. If not, be sure to have [Deno](https://deno.land) installed first, then run: -Open (`cmd+k`) your `PLUGS` note in SilverBullet and add this plug to the list: - -```yaml -- https://github.com/Willyfrog/silverbullet-plug-example/releases/download/v0.1/helloworld.plug.json +```shell +deno install -f -A --unstable --importmap https://deno.land/x/silverbullet/import_map.json https://deno.land/x/silverbullet/plugos/bin/plugos-bundle.ts ``` -Then run the `Plugs: Update` command and off you go! +After this, build the plug with + +```shell +deno task build +``` + +Or to watch for changes and rebuild automatically + +```shell +deno task watch +``` + +Then, load the locally built plug, add it to your `PLUGS` note with an absolute path, for instance: + +``` +- file:/Users/you/path/to/hello.plug.json +``` + +And run the `Plugs: Update` command in SilverBullet. +## Installation +If you would like to install this plug straight from Github, make sure you have the `.json` file committed to the repo and simply add + +``` +- github:user/plugname/plugname.plug.json +``` + +to your `PLUGS` file, run `Plugs: Update` command and off you go! ## What's with all that Lone Ranger quotes