Update README

[swetha1654]

Overview

Updated the README file to be compliant with is-charms-template-repo

Checklist

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

[erinecon]

Thanks for updating this README! It looks really great. I have two suggestions :)

[erinecon]

Thanks for updating the README! I approve of this doc change 👍
(Not giving an official approval since there are code changes in this PR.)

[erinecon]

A few more small comments related to the style guide

[erinecon]

Thanks for updating the README! I approve of the doc changes 👍
(Not giving an official approve due to the code changes in this PR.)

[github-actions]

Test coverage for 7b2131d

Name                 Stmts   Miss Branch BrPart  Cover   Missing
----------------------------------------------------------------
src/charm.py           186     11     34      8    91%   146-147, 167-168, 187, 227-229, 243->255, 328->331, 353, 366, 375->378, 460
src/file_reader.py      17      0      4      0   100%
----------------------------------------------------------------
TOTAL                  203     11     38      8    92%

Static code analysis report

Run started:2024-12-20 05:03:42.343896

Test results:
  No issues identified.

Code scanned:
  Total lines of code: 1269
  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):