Updated README

This commit is contained in:
Zef Hemel
2022-10-15 20:23:55 +02:00
parent cb79d165a5
commit 8218429ad4

View File

@@ -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