qownnotes-scripts/README.md

# QOwnNotes script repository

[Installation](http://www.qownnotes.org/installation) | 
[Changelog](https://github.com/pbek/QOwnNotes/blob/develop/CHANGELOG.md) | 
[Issues](https://github.com/qownnotes/scripts/issues) | 
[Releases](https://github.com/pbek/QOwnNotes/releases) |
[Documentation](http://docs.qownnotes.org) |
[IRC Chat](https://kiwiirc.com/client/irc.freenode.net/#qownnotes) |
[Gitter Chat](https://gitter.im/qownnotes/qownnotes)

[![Build Status](https://travis-ci.org/qownnotes/scripts.svg?branch=master)](https://travis-ci.org/qownnotes/scripts)
[![Percentage of issues still open](http://isitmaintained.com/badge/open/qownnotes/scripts.svg)](http://isitmaintained.com/project/qownnotes/scripts "Percentage of issues still open")
[![Gitter chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://gitter.im/qownnotes/qownnotes)
[![Documentation](https://readthedocs.org/projects/qownnotes/badge/?version=develop)](http://docs.qownnotes.org)

Here you will find the scripts you can directly access in [QOwnNotes](http://www.qownnotes.org), the plain-text file notepad with markdown support and Nextcloud and ownCloud integration.

Please visit the [Scripting documentation](http://docs.qownnotes.org/en/develop/scripting/README.html) for more information about scripting and how to write your own.

To bring your script into the **script repository** you just have to do the following:

- **[fork](https://help.github.com/articles/fork-a-repo/)** the repository <https://github.com/qownnotes/scripts> on GitHub
- checkout your forked repository with `git clone https://github.com/YOUR_GITHUB_NAME/scripts.git qownnotes-scripts`
- **duplicate** the **`example-script` folder** and give it an other descriptive name
- **add your script** to the folder and remove the `example-script.qml`
- **edit** the **`info.json`** to add your meta data and describe what your script is doing
  - you can use [example script info.json](https://jsoneditoronline.org/?url=https%3A%2F%2Fraw.githubusercontent.com%2Fqownnotes%2Fscripts%2Fmaster%2Fexample-script%2Finfo.json) to help you with the json encoding
  - if you are not sure which `minAppVersion` the commands you are using needs take the [current version](https://github.com/pbek/QOwnNotes/blob/master/src/version.h) of *QOwnNotes*
- **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
added a travis badge 2017-05-16 14:31:25 +00:00			`# QOwnNotes script repository`

added badges and links 2017-05-17 13:13:26 +00:00			`[Installation](http://www.qownnotes.org/installation) \|`
			`[Changelog](https://github.com/pbek/QOwnNotes/blob/develop/CHANGELOG.md) \|`
			`[Issues](https://github.com/qownnotes/scripts/issues) \|`
			`[Releases](https://github.com/pbek/QOwnNotes/releases) \|`
			`[Documentation](http://docs.qownnotes.org) \|`
			`[IRC Chat](https://kiwiirc.com/client/irc.freenode.net/#qownnotes) \|`
			`[Gitter Chat](https://gitter.im/qownnotes/qownnotes)`

added a travis badge 2017-05-16 14:31:25 +00:00			`[![Build Status](https://travis-ci.org/qownnotes/scripts.svg?branch=master)](https://travis-ci.org/qownnotes/scripts)`
added badges and links 2017-05-17 13:13:26 +00:00			`[![Percentage of issues still open](http://isitmaintained.com/badge/open/qownnotes/scripts.svg)](http://isitmaintained.com/project/qownnotes/scripts "Percentage of issues still open")`
			`[![Gitter chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://gitter.im/qownnotes/qownnotes)`
			`[![Documentation](https://readthedocs.org/projects/qownnotes/badge/?version=develop)](http://docs.qownnotes.org)`
added a travis badge 2017-05-16 14:31:25 +00:00
added a missing word 2018-05-12 04:47:24 +00:00			`Here you will find the scripts you can directly access in [QOwnNotes](http://www.qownnotes.org), the plain-text file notepad with markdown support and Nextcloud and ownCloud integration.`
added a travis badge 2017-05-16 14:31:25 +00:00
added more documentation 2017-05-17 13:06:13 +00:00			`Please visit the [Scripting documentation](http://docs.qownnotes.org/en/develop/scripting/README.html) for more information about scripting and how to write your own.`
added documentation 2017-05-17 13:03:57 +00:00
			`To bring your script into the script repository you just have to do the following:`

added repository url 2018-05-13 15:11:31 +00:00			`- [fork](https://help.github.com/articles/fork-a-repo/) the repository <https://github.com/qownnotes/scripts> on GitHub`
added checkout information 2017-06-03 08:13:02 +00:00			- checkout your forked repository with `git clone https://github.com/YOUR_GITHUB_NAME/scripts.git qownnotes-scripts`
added more information 2018-05-13 15:27:01 +00:00			- duplicate the `example-script` folder and give it an other descriptive name
added documentation 2017-05-17 13:03:57 +00:00			- add your script to the folder and remove the `example-script.qml`
added more information 2018-05-13 15:27:01 +00:00			- edit the `info.json` to add your meta data and describe what your script is doing
fixed json preview url 2018-05-07 17:29:34 +00:00			`- you can use [example script info.json](https://jsoneditoronline.org/?url=https%3A%2F%2Fraw.githubusercontent.com%2Fqownnotes%2Fscripts%2Fmaster%2Fexample-script%2Finfo.json) to help you with the json encoding`
added current version link 2018-05-13 15:30:21 +00:00			- if you are not sure which `minAppVersion` the commands you are using needs take the [current version](https://github.com/pbek/QOwnNotes/blob/master/src/version.h) of QOwnNotes
added documentation 2017-05-17 13:03:57 +00:00			`- 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`