Update README.md

[Thanhphan1147]

Update README to follow the template defined at : https://github.com/canonical/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)

[github-actions]

Lint checks failed for e86975e

```

tests/integration/helpers.py:84: error: Item "Type" of "Type | None" has no attribute "units" [union-attr]
tests/integration/helpers.py:84: error: Item "None" of "Type | None" has no attribute "units" [union-attr]
tests/integration/test_cos.py:40: error: Item "Type" of "Type | None" has no attribute "units" [union-attr]
tests/integration/test_cos.py:40: error: Item "None" of "Type | None" has no attribute "units" [union-attr]
tests/integration/test_cos.py:89: error: Item "Type" of "Type | None" has no attribute "units" [union-attr]
tests/integration/test_cos.py:89: error: Item "None" of "Type | None" has no attribute "units" [union-attr]
tests/integration/test_cos.py:158: error: Item "Type" of "Type | None" has no attribute "units" [union-attr]
tests/integration/test_cos.py:158: error: Item "None" of "Type | None" has no attribute "units" [union-attr]
tests/integration/conftest.py:134: error: Item "Type" of "Type | None" has no attribute "units" [union-attr]
tests/integration/conftest.py:134: error: Item "None" of "Type | None" has no attribute "units" [union-attr]
tests/integration/conftest.py:486: error: Item "Type" of "Type | None" has no attribute "units" [union-attr]
tests/integration/conftest.py:486: error: Item "None" of "Type | None" has no attribute "units" [union-attr]
tests/integration/conftest.py:785: error: Item "Type" of "Type | None" has no attribute "units" [union-attr]
tests/integration/conftest.py:785: error: Item "None" of "Type | None" has no attribute "units" [union-attr]
Found 14 errors in 3 files (checked 43 source files)

[github-actions]

Test coverage for e86975e

Name                Stmts   Miss Branch BrPart  Cover   Missing
---------------------------------------------------------------
src/actions.py         29      0      4      0   100%
src/agent.py          119      0     20      0   100%
src/auth_proxy.py      52      0      8      0   100%
src/charm.py           89      0     10      0   100%
src/cos.py             20      0      0      0   100%
src/ingress.py         16      0      4      0   100%
src/jenkins.py        377      0     50      0   100%
src/pebble.py          25      0      0      0   100%
src/state.py          109      0     16      0   100%
src/timerange.py       30      0      4      0   100%
---------------------------------------------------------------
TOTAL                 866      0    116      0   100%

Static code analysis report

Run started:2024-12-20 15:14:23.935989

Test results:
  No issues identified.

Code scanned:
  Total lines of code: 7617
  Total lines skipped (#nosec): 6
  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):

[erinecon]

Thank you for updating the README!

[erinecon]

Suggested change

	To begin, refer to the [Getting Started](https://charmhub.io/jenkins-k8s/docs/tutorial-getting-started) tutorial for step-by-step instructions.
	To begin, refer to the [tutorial](https://charmhub.io/jenkins-k8s/docs/tutorial-getting-started) for step-by-step instructions.

[erinecon]

Suggested change

	See the [how-to-integrate-with-external-agents](https://charmhub.io/jenkins-k8s/docs/how-to-integrate-with-external-agents) section in the jenkins-k8s-operator documentation.
	See the [how to integrate with external agents](https://charmhub.io/jenkins-k8s/docs/how-to-integrate-with-external-agents) section in the jenkins-k8s-operator documentation.

[erinecon]

• Is there an official website for Jenkins that is worth listing here?
• Similarly, are there any developer docs for Jenkins?
• Finally, could you add an item [Troubleshooting](https://matrix.to/#/#charmhub-charmdev:ubuntu.com) to this list?

[erinecon]

Could you link https://github.com/canonical/jenkins-k8s-operator/blob/main/CONTRIBUTING.md instead?