Hint for developers: If you maintain a README.md file in the root of your package folder (which is not necessarily the root of your repository), this file is rendered into the overview page of your package at index.ros.org.
The file may be used for documenting your package and supersedes the package documentation pages in the ROS Wiki from ROS 1.
See the fmi_adapter package as an example.