Review readme file

Problem/Motivation

The module maintainers want to ensure the readme file is clear and does not lack vital information.

Steps to reproduce

• Open the readme file in the code base
• Follow the instructions
• Check if there is anything missing or unclear

Proposed resolution

Check the readme file and make suggestions to change or add relevant information.

Remaining tasks

Check the readme file and make suggestions to change or add relevant information.

User interface changes

• None

API changes

• None

Data model changes

• None