Skip to content

Commit

Permalink
Add update instructions to README
Browse files Browse the repository at this point in the history
  • Loading branch information
zerebos committed Jun 19, 2024
1 parent 21f0a44 commit 8b3484e
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 2 deletions.
28 changes: 27 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,18 @@ There are some features specific to the desktop client of Trilium.
1. Import the zip into Trilium, but make sure you uncheck `Safe Import`!


## Updating

Since every install of this plugin has a new renderer `html` and `js` (though there's not always guaranteed to be changes), there was some functionality added into the plugin to make migrating to new versions a little easier.

1. Install the new version using the steps from above
1. Delete the old version of the plugin
1. Open the plugins settings page
1. Scroll to the bottom
1. Click "Fix ~renderNote Attributes"

Once this is considered more stable, the plugin will prompt you with this as soon as you install so you don't have to remember to do it.


## Usage

Expand All @@ -48,4 +60,18 @@ There are some features specific to the desktop client of Trilium.

1. Use the UI to change the folder to be watched
- User downloads folder is used by default
1. Download a webpage using SingleFile
1. Download a webpage using SingleFile


## Links

Check out my other Trilium-based projects:
- [Trilium Markdown Preview](https://github.com/rauenzi/Trilium-MarkdownPreview)
- [Trilium LaTeX Preview](https://github.com/rauenzi/Trilium-LaTeXPreview)
- [Trilium Breadcrumbs](https://github.com/rauenzi/Trilium-Breadcrumbs)
- [Trilium SingleFile](https://github.com/rauenzi/Trilium-SingleFile)
- [Trilium Types](https://github.com/rauenzi/trilium-types)
- [Trilium ETAPI](https://github.com/rauenzi/trilium-etapi)
- [Trilium Pack](https://github.com/rauenzi/trilium-pack)

Want more? Be sure to check out the [Awesome Trilium](https://github.com/Nriver/awesome-trilium) list!
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "trilium-singlefile",
"version": "0.1.0",
"version": "0.1.1",
"description": "An addon for Trilium to easily import SingleFile archives.",
"homepage": "https://github.com/rauenzi/Trilium-SingleFile",
"repository": {
Expand Down

0 comments on commit 8b3484e

Please sign in to comment.