Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: Update README.md #19

Merged
merged 1 commit into from
Jan 29, 2025
Merged

docs: Update README.md #19

merged 1 commit into from
Jan 29, 2025

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)

TheRealAgentK
TheRealAgentK approved these changes Jan 29, 2025
View reviewed changes
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
Reviewers

@TheRealAgentK TheRealAgentK TheRealAgentK approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@miquelbeltran @TheRealAgentK