ISD-2543 - Update README

[swetha1654]

Overview

Update the charm’s README on GitHub to follow the template outlined in is-charms-template-repo.

Checklist

• [x] The charm style guide was applied
• [x] The contributing guide was applied
• [x] The changes are compliant with ISD054 - Managing Charm Complexity
• [x] The documentation is generated using src-docs
• [x] The documentation for charmhub is updated.
• [x] The PR is tagged with appropriate label (urgent, trivial, complex)

[github-actions[bot]]

Test coverage for 74749c83586b8fb06d3d92f750c8b875f98ee0b8

Name                Stmts   Miss Branch BrPart  Cover   Missing
---------------------------------------------------------------
src/charm.py          557     35    174     34    91%   162, 204-207, 299->302, 414, 473->477, 627, 658, 664, 681-685, 715, 750-751, 811, 820, 924->937, 936, 938, 943-944, 1004, 1024, 1031, 1121, 1130, 1142, 1163, 1172, 1191, 1195, 1224, 1265, 1397, 1419, 1426->1428, 1471->exit, 1483, 1493, 1531
src/cos.py             20      0      0      0   100%
src/exceptions.py      16      1      2      1    89%   41
src/state.py           33      0      2      0   100%
src/types_.py          15      0      0      0   100%
---------------------------------------------------------------
TOTAL                 641     36    178     35    91%

Static code analysis report

Run started:2024-11-29 04:46:22.116835

Test results:
    No issues identified.

Code scanned:
    Total lines of code: 4647
    Total lines skipped (#nosec): 1
    Total potential issues skipped due to specifically being disabled (e.g., #nosec BXXX): 0

Run metrics:
    Total issues (by severity):
        Undefined: 0
        Low: 0
        Medium: 0
        High: 0
    Total issues (by confidence):
        Undefined: 0
        Low: 0
        Medium: 0
        High: 0
Files skipped (0):