update mermaid link, install instructions

[mnbf9rca]

Summary by Sourcery

This pull request updates the README documentation to improve installation instructions, clarify response object properties related to caching, and provide an online link for the Mermaid visualisation of the Pydantic models.

• Documentation:
  • Updated installation instructions to include both pip and poetry commands.
  • Clarified the properties content_expires and shared_expires in the response objects, explaining their calculation and usage for caching.
  • Added a link to view the Mermaid visualisation of the Pydantic models online.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request updates the README.md file to correct the installation instructions, add an alternative installation method using Poetry, and provide more detailed information about the content_expires and shared_expires properties. Additionally, it updates the Mermaid visualisation section to include a link to view the diagram online.

File-Level Changes

Files	Changes
README.md	Updated installation instructions, added alternative installation method, provided more details on content_expires and shared_expires properties, and included a link to view the Mermaid visualisation online.

---

Tips

• Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
• Continue your discussion with Sourcery by replying directly to review comments.
• You can change your review settings at any time by accessing your dashboard:
  • Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
  • Change the review language;
• You can always contact us if you have any questions or feedback.

[sourcery-ai]

Hey @mnbf9rca - I've reviewed your changes - here's some feedback:

Overall Comments:

• Can you clarify if the change from pydantic-tfl-api to pydantic_tfl_api in the installation command is intentional? If so, does this reflect a change in the package name that might require additional documentation or migration notes?

Here's what I looked at during the review

• 🟢 General issues: all looks good
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.}