Make the content of generated md files to be markdown compatible

[thil4n]

Purpose

This PR fixes the Markdown compatibility issue in the generated readme.md file for bal new -t lib command.

Fixes #42907

Approach

Edit the static file cli/ballerina-cli/src/main/resources/new_cmd_defaults/README.md.

Check List

• Read the Contributing Guide
• Updated Change Log
• Checked Tooling Support (#)
• Added necessary tests
  • Unit Tests
  • Spec Conformance Tests
  • Integration Tests
  • Ballerina By Example Tests
• Increased Test Coverage
• Added necessary documentation
  • API documentation
  • Module documentation in Module.md files
  • Ballerina By Examples

[azinneera]

The first 2 commit messages can be squashed into one since the messages seem to be the same. The commit message should start with Uppercase and in the imperative mood.

[thil4n]

The first 2 commit messages can be squashed into one since the messages seem to be the same. The commit message should start with Uppercase and in the imperative mood.

Ack, Will use proper commit messages.