Add README

README.md

@@ -1,24 +1,54 @@
-# Joplin Plugin
+# Joplin Combine notes
 
-This is a template to create a new Joplin plugin.
+Plugin to combine one or more notes to a new one.
 
-The main two files you will want to look at are:
+<img src=img/main.jpg>
 
-- `/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.
+## Installation
 
-## Building the plugin
+### Automatic
 
-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.
+- Go to `Tools > Options > Plugins`
+- Search for `combine`
+- Click Install plugin
+- Restart Joplin to enable the plugin
 
-To build the plugin, simply run `npm run dist`.
+### Manual
 
-The project is setup to use TypeScript, although you can change the configuration to use plain JavaScript.
+- Download the latest released JPL package (`io.github.jackgruber.combine.jpl`) from [here](https://github.com/JackGruber/joplin-plugin-combine/releases/latest)
+- Open Joplin
+- Go to `Tools > Options > Plugins`
+- Click Install plugin and select the downloaded jpl file
+- Restart Joplin to enable the plugin
+
+## Usage
+
+- Select multiple notes to be combined into a new one
+- Click on `Tools > Combine selected notes` or use the command `Combine selected notes` from the context menu
+
+## Keyboard Shortcus
+
+Under `Options > Keyboard Shortcus` you can assign a keyboard shortcut for the following commands:
+
+- `Combine selected notes`
+
+## Build
+
+To build your one version of the plugin, install node.js and run the following command `npm run dist`
 
 ## Updating the plugin framework
 
 To update the plugin framework, run `npm run update`.
 
-In general this command tries to do the right thing - in particular it's going to merge the changes in package.json and .gitignore instead of overwriting. It will also leave "/src" as well as README.md untouched.
+## Changelog
+
+### v0.1.0 (2021-01-08)
+
+- First version
+
+## Links
 
-The file that may cause problem is "webpack.config.js" because it's going to be overwritten. For that reason, if you want to change it, consider creating a separate JavaScript file and include it in webpack.config.js. That way, when you update, you only have to restore the line that include your file.
+- [Joplin - Getting started with plugin development](https://joplinapp.org/api/get_started/plugins/)
+- [Joplin - Plugin API reference](https://joplinapp.org/api/references/plugin_api/classes/joplin.html)
+- [Joplin - Data API reference](https://joplinapp.org/api/references/rest_api/)
+- [Joplin - Plugin examples](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins)