forked from GitHubMirrors/silverbullet-icalendar
Align project structure with silverbullet-plug-template
Some checks failed
Build SilverBullet Plug / build (push) Failing after 11s
Some checks failed
Build SilverBullet Plug / build (push) Failing after 11s
- Rename deno.jsonc to deno.json and update build tasks - Add PLUG.md for SB v2 installation - Update .gitignore to include .plug.js files - Update README.md with new installation instructions - Simplify GitHub workflow
This commit is contained in:
20
README.md
20
README.md
@@ -7,11 +7,11 @@ It reads external [iCalendar](https://en.wikipedia.org/wiki/ICalendar) data, als
|
||||
|
||||
## Installation
|
||||
|
||||
Run the {[Plugs: Add]} command in SilverBullet and add paste this URI into the dialog box:
|
||||
Run the {[Library: Install]} command and paste the following URL:
|
||||
`https://github.com/Maarrk/silverbullet-icalendar/blob/main/PLUG.md`
|
||||
|
||||
```
|
||||
ghr:Maarrk/silverbullet-icalendar
|
||||
```
|
||||
Alternatively, you can use the older way with the {[Plugs: Add]} command:
|
||||
`ghr:Maarrk/silverbullet-icalendar`
|
||||
|
||||
Then run the {[Plugs: Update]} command and off you go!
|
||||
|
||||
@@ -92,25 +92,19 @@ If you find bugs, report them on the [issue tracker on GitHub](https://github.co
|
||||
|
||||
### Building from source
|
||||
|
||||
To build this plug, make sure you have [SilverBullet installed](https://silverbullet.md/Install). Then, build the plug with:
|
||||
To build this plug, you need [Deno](https://deno.land/) installed. Then, build the plug with:
|
||||
|
||||
```shell
|
||||
deno task build
|
||||
```
|
||||
|
||||
Or to watch for changes and rebuild automatically
|
||||
Or to watch for changes and rebuild automatically:
|
||||
|
||||
```shell
|
||||
deno task watch
|
||||
```
|
||||
|
||||
Then, copy the resulting `.plug.js` file into your space's `_plug` folder. Or build and copy in one command:
|
||||
|
||||
```shell
|
||||
deno task build && cp *.plug.js /my/space/_plug/
|
||||
```
|
||||
|
||||
SilverBullet will automatically sync and load the new version of the plug (or speed up this process by running the {[Sync: Now]} command).
|
||||
The compiled plug will be written to `icalendar.plug.js`. This file is tracked by Git in this repository to allow for easy installation via the `PLUG.md` file.
|
||||
|
||||
## License
|
||||
|
||||
|
||||
Reference in New Issue
Block a user