Update readme to for more details

[Yanglin-Tao]

Pull Request Template

Description

Update documentation.

Fixes # (issue)

Type of change

• [ ] Bug fix (non-breaking change which fixes an issue)
• [ ] New feature (non-breaking change which adds functionality)
• [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
• [ ] Documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration.

• [ ] Test A
• [ ] Test B

Checklist:

• [ ] My code follows the style guidelines of this project
• [ ] I have performed a self-review of my own code
• [ ] I have commented my code, particularly in hard-to-understand areas
• [ ] I have made corresponding changes to the documentation
• [ ] My changes generate no new warnings
• [ ] Any dependent changes have been merged and published in downstream modules

Note:

Include the information the reviewers need to know.

[vchrombie]

@Kylin-Mao @Yanglin-Tao

The CI fails, but the PR is approved and merged.

This is not a good practice. You need to make sure the CI is passing always. If it fails for some reason, it should be a priority to fix the CI failure unless it is for obvious reasons.