...

• Create a markdown file named README.md
• Save it in the top level of your IGB App project (same level as pom.xml)

Add app.description property

Add an app.description tag within the properties tag of pom.xml, and use it to specify the name of your markdown file:

<properties>
    <app.description>AppDescription.md</app.description>
 </properties>

Add Bundle-Description tag to pom.xml

...

The bundle-markdown-encoder module uses Base64 encoding to translate the content of your Markdown document into a sequence of alphanumeric characters. It inserts this sequence into the description tag of the repository.xml file that you create when you compile your App using maven. When users add a new App repository and then select an App, IGB uses decodes the contents of the App's description tag and displays it them in the App Manager. The App Manager contains code that can render the Markdown. 

Note that currently, if you would like to reference an image in your README.md, you'll need to use an absolute URL to wherever the image is hosted. You'll also need to ensure that the image URL is always accessible.  We recommend that if you are hosting your own App repository, you keep the images you need there. This will ensure that if users can download your App to install it, IGB can also download the image. 

...