Skip to content

docs: Update README.md#19

Merged
TheRealAgentK merged 1 commit intomainfrom
miquelbeltran-patch-1
Jan 29, 2025
Merged

docs: Update README.md#19
TheRealAgentK merged 1 commit intomainfrom
miquelbeltran-patch-1

Conversation

@miquelbeltran
Copy link
Contributor

docs: Update README.md

Description 📝

  • Purpose: Add badges to the README and cleanup a bit the installation instructions.
  • Approach: Modify README.md

Type of change

  • Docs

Updates

  • Changed the Install section, moved the dart requirement instructions.
  • Added badges for GitHub releases and pub.dev, including links (see screenshot)

Screenshots 📷

Screenshot from 2025-01-29 09-31-24

Test plan 🧪

  • None, only docs changed

Author to check 👓

  • Project and all contained modules builds successfully
  • Self-/dev-tested
  • Unit/UI/Automation/Integration tests provided where applicable
  • Code is written to standards
  • Appropriate documentation written (code comments, internal docs)

Reviewer to check ✔️

  • Project and all contained modules builds successfully
  • Change has been dev-/reviewer-tested, where possible
  • Unit/UI/Automation/Integration tests provided where applicable
  • Code is written to standards
  • Appropriate documentation written (code comments, internal docs)

Copy link
Contributor

@TheRealAgentK TheRealAgentK left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@TheRealAgentK TheRealAgentK merged commit a131bbd into main Jan 29, 2025
5 checks passed
@miquelbeltran miquelbeltran deleted the miquelbeltran-patch-1 branch January 29, 2025 10:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants