Plugin requirements

{
    "name"              : "PluginXY",
    "namespace"         : "PluginXY",
    "type"              : "template",
    "version"           : "1.0.0",
    "isClosedSource"    : "Determines if your plugin is closed source or open source",
    "pluginIcon"        : "The plugin icon",
    "description"       : "The description for your plugin",
    "author"            : "Your name",
    "authorIcon"        : "The author icon",
    "email"             : "Your email address",
    "phone"             : "Your phone number",
    "serviceProvider"   : "XY\\Providers\\TemplateServiceProvider",
    "containers"        : [],
    "dataProviders"     : [],
    "javaScriptFiles"   : [],
    "require"           : [],
    "dependencies"      : [],
    "runOnBuild"        : []
}

{
    "marketplaceName"   : {"de":"German display name of plugin","en":"English display name of plugin"},
    "license"           : "The license for the plugin",
    "price"             : 0.00,
    "shortDescription"  : {"de":"German short description","en":"English short description"},
    "categories"        : ["3518"],
    "keywords"          : ["plugins", "template"]
}

# Release Notes for PluginXY // Include the plugin name in headline 1

## v1.0.1 (2016-12-24) // List version releases (MAJOR.MINOR.PATCH) with
                       // the release date (YYYY-MM-DD) in reverse-chronological
                       // order (newest on top) in headline 2

### Added // List added features and functions in an unordered list
- Added new feature 1
- Added new feature 2

### Changed // List all changes made to existing functionality in an unordered list
- Replaced icon 1 with icon 2

### Fixed // List all bug fixes and fixed issues in an unordered list
- Fixed bug 1

### Removed // List all removed features and functions in this release in an unordered list
- Removed redundant function 1

### TODO //List all steps the user has to carry out for the new version to work properly
- Update some other plugin 1
- Perform additional setup

## v1.0.0 (2016-11-08) // Add one sub-section for each version with the release date in headline 2

### Added // List added features and functions in an unordered list
- Added function 1

# This is the headline of your user guide

Below the headline, include a short introduction describing your plugin, the scope of functionality and link the main features.

## Getting started and requirements

In the first chapter, provide information about setting up the plugin. Provide a short **Getting started** section. Also, mention **required plugins**, that must be installed to run your plugin. Finally, if the customer needs any **external resources** to configure the plugin, such as API keys, provide a step-by-step description for how to access them.

## Plugin configuration

Main chapters can be used to give a detailed description of the settings of your plugins. You can group settings descriptions.

### The first feature of the plugin

Single features are described in a sub-section. If you want to give instructions for setting up a function in the plentymarkets back end, use the following template:

##### Setting up a feature:

1. Go to the **Plugins » Plugin overview** menu.
2. Click on **My plugin**.<br />→ A new window will open.
3. Select a value from the **My plugin feature** drop-down.
4. **Save** the settings.

### Another feature

Add the instructions. In this case we want to describe more than one setting, so we use a table below the instructions.

![Add an image](http://placehold.it/350x150?text=Add+an+image)

##### Setting up another feature with multiple settings:

1. Go to the **Plugins » Plugin overview** menu.
2. Click on **My plugin**.<br />→ A new window will open.
3. Carry out the settings. Pay attention to the information given in table 1.
4. **Save** the settings.

| Settings  | Explanation   |
|-----------|---------------|
| Setting 1 | Description 1 |
| Setting 2 | Description 2 |
| Setting 3 | Description 3 |

Table 1: Settings for another feature

## Highlighting

### Boldface

Use **bold** for highlighting UI texts, menus and options.

### Code

A single line of code is highlighted using <code>`</code> at the beginning and at the end of the line:

`This is a line of code`

If you want to include multiple lines of code, use <code>```</code> before and after a code example.

```
Line 1 of code
Line 2 of code
Line 3 of code
```


### Warning

<div class="alert alert-danger" role="alert">
    This is a red box. Use this box for warning messages.
</div>

### Important

<div class="alert alert-warning" role="alert">
    This is a yellow box. Use this box for important information.
</div>

### Example

<div class="alert alert-success" role="alert">
    This is a green box. Use this box for examples.
</div>

### Note

<div class="alert alert-info" role="alert">
    This is a blue box. Use this box for notes.
</div>


## Further reading

Add links to further information.

* Here you can find a [markdown cheatsheet](https://guides.github.com/pdfs/markdown-cheatsheet-online.pdf)
* [More markdown](http://www.markdowntutorial.com/)

## License

In this section, you can add information about your license, e.g. this project is licensed under the GNU AFFERO GENERAL PUBLIC LICENSE - see the [LICENSE.md](/LICENSE.md) file for details.

## Web page

Add your web page, e.g. as a link

## Email

Add your email address for support issues, e.g. as a link

## Phone

Add your phone number