From 5836dfdb2e91ff75acc6e995c4c693608561c4ac Mon Sep 17 00:00:00 2001 From: Franco Speziali Date: Thu, 17 Mar 2022 15:55:37 +0100 Subject: [PATCH] Skeleton README.md added --- README.md | 23 +++-------------------- 1 file changed, 3 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index b7f1e92..a15258b 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,7 @@ -# Joplin Plugin +# Event Calendar Plugin for Joplin -This is a template to create a new Joplin plugin. -The main two files you will want to look at 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. +## Acknowledgements -## 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. - -To build the plugin, simply run `npm run dist`. - -The project is setup to use TypeScript, although you can change the configuration to use plain JavaScript. - -## 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. - -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. +This project was inspired by the [Joplin Life Calendar Plugin](https://github.com/hieuthi/joplin-plugin-life-calendar)