Add documentation for ability to use Markdown

Signed-off-by: Carmen Bianca BAKKER <[email protected]>
OCA · Oct 14, 2024 · dc9127c · dc9127c
1 parent 886047f
commit dc9127c
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/template/module/README.rst b/template/module/README.rst
@@ -15,6 +15,9 @@ Please provide content in the ``readme`` directory:
 * CREDITS.rst (optional)
 * HISTORY.rst (optional, recommended)
 
+Instead of using reStructuredText (``.rst``), you may use Markdown (``.md``) to
+format your files.
+
 Content of this README will also be drawn from the addon manifest,
 from keys such as name, authors, maintainers, development_status,
 and license.