<readme> Element

The <readme> element is a child of the <plugin> element and is used to declare the location of a readme.txt file in the plug-in JAR. This readme.txt file is expected to be a Unicode-encoded text file. The byte order mark (BOM) is used to specify the Unicode encoding. If no BOM is present, UTF-8 encoding will be used by default.

The <readme> element has one attribute, jarPath, that contains the path name to the readme file. The path name of the readme file is relative to the root of the plug-in JAR file. Leading slash (/) or period (.) characters are not permitted in the jarPath.