Skip to content

Commit

Permalink
docs: update plugin-store link & fix typos
Browse files Browse the repository at this point in the history
Signed-off-by: Henrik Gerdes <[email protected]>
  • Loading branch information
hegerdes committed Apr 15, 2024
1 parent 97118f7 commit 4769131
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ This way you can always work with the latest version of online cheat sheets/webs

## Install
**Official:**
Joplin has a community store with an integrated browser for plugin. This plugin is now also released there. Just search for `remote-note-pull`.
Joplin has a [community plugin store](https://joplinapp.org/plugins/plugin/github.hegerdes.joplin_remote_note_pull/) with an integrated browser for plugin. This plugin is now also released there. Just search for `remote-note-pull`.

**Manual:**
You can get the latest version like this:
* Download the latest release from [GitHub Releases](https://github.com/hegerdes/joplin-plugin-remote-note-pull/releases) or [npmjs](https://www.npmjs.com/package/joplin-plugin-remote-note-pull)
* Download the latest release from [GitHub Releases](https://github.com/hegerdes/joplin-plugin-remote-note-pull/releases) or [NpmJs](https://www.npmjs.com/package/joplin-plugin-remote-note-pull)
* Extract the archive
* Open Joplin and open the Settings via the Tools/Options menu
* Go to Plugins
Expand All @@ -28,25 +28,27 @@ Enter a URL and wait some second. The newly created note will be periodically up
![New Note Option Dialog](docs/images/new_note_dialog.png)

You can change the default interval via the Joplin settings. A new option group will be added on plugin install. It allows you to enable the sync feature, sets the sync interval and the default target notebook.
With the *DownArrow* Icon in the top left you can also trigger a manual update in any currently selected sync-note.
With the *DownArrow* Icon in the top right you can also trigger a manual update on any currently selected sync-note.

![Settings Dialog](docs/images/settings.png)

## Contribute
If you have any feature requests or found a bug feel free to open a [GitHub Issue](https://github.com/hegerdes/joplin-plugin-remote-note-pull/issues/new/choose) or even provide a pull-request.

## Develop
Make sure you have nodeJS >= 14 installed
## Development
Make sure you have nodeJS >= 16 installed

Clone the repo and open it in your favourite editor. The most important files are:

- `/src/index.ts`, which contains the entry point for the plugin source code.
- `/src/manifest.json`, which is the plugin manifest. It contains information such as the plugin a name, version, etc.

See here for information about publishing [Joplin Forum](https://discourse.joplinapp.org/t/plugins-multiple-questions-sharing-publishing-etc/30551)
For mor€information see [here](https://github.com/laurent22/joplin/tree/dev/packages/generator-joplin#publishing-the-plugin)
For more information see [here](https://github.com/laurent22/joplin/tree/dev/packages/generator-joplin#publishing-the-plugin)

## Building the plugin

The plugin is built using Webpack, which creates the compiled code in `/dist`. A JPL archive will also be created at the root, which can use to distribute the plugin.
The plugin is built using Webpack, which creates a compiled bundle in `/dist`. A JPL archive will also be created at the root, which can use to distribute the plugin.

To build the plugin, simply run `npm run dist`.

Expand Down

0 comments on commit 4769131

Please sign in to comment.