From 7b6e325b3523de1a42a859035adbae227fe4b46a Mon Sep 17 00:00:00 2001 From: Patrizio Bekerle Date: Wed, 17 May 2017 15:03:57 +0200 Subject: [PATCH] added documentation --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index a96e773..5ec6f93 100644 --- a/README.md +++ b/README.md @@ -5,3 +5,13 @@ Here you will find all the scripts you can access in [QOwnNotes](http://www.qownnotes.org). Please visit the [Scripting documentation](http://docs.qownnotes.org/en/develop/scripting/README.html) for more information about scripting. + +To bring your script into the **script repository** you just have to do the following: + +- **[fork](https://help.github.com/articles/fork-a-repo/)** this repository +- **duplicate** the **`example-script` folder** and give it an other name +- **add your script** to the folder and remove the `example-script.qml` +- **edit** the **`info.json`** to add your meta data + - you can use [example script info.json](http://www.jsoneditoronline.org/?url=https%3A%2F%2Fraw.githubusercontent.com%2Fqownnotes%2Fscripts%2Fmaster%2Fexample-script%2Finfo.json) to help you with the json encoding +- **commit and push** your changes to your repository +- create a **[pull request](https://help.github.com/articles/creating-a-pull-request/)** to get your script merged into the QOwnNotes script repository