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.

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

docs/update the readme #246

Merged
merged 5 commits into from
Dec 20, 2024
Merged

docs/update the readme #246

merged 5 commits into from
Dec 20, 2024

Conversation

tercierp
Copy link
Collaborator

Overview

This PR updates the content of the readme

  • Paragraph texts updated
  • Added images to display some screenshots of the app
  • Architecture diagram updated

@tercierp tercierp added the Documentation 📄 Improvements or additions to documentation label Dec 19, 2024
@tercierp tercierp added this to the Milestone M3 milestone Dec 19, 2024
@tercierp tercierp self-assigned this Dec 19, 2024
@tercierp tercierp linked an issue Dec 19, 2024 that may be closed by this pull request
3 tasks
@tercierp tercierp marked this pull request as ready for review December 19, 2024 16:39
Copy link
Contributor

@kzepfl kzepfl left a comment

Choose a reason for hiding this comment

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

There was a a part where I think maybe adding something would be beneficial, but it is not necessary.
I approve this request

README.md Outdated
- The app suggests users who frequent the same or nearby parks, helping to create workout communities. Users are also encouraged to schedule joint sessions.

4. **Progression**
- The app includes an achievement and progression system where users can track their milestones, unlock badges for completing specific goals. This gamification feature motivates users by rewarding consistent effort and providing a visual representation of their progress over time.
Copy link
Contributor

@kzepfl kzepfl Dec 19, 2024

Choose a reason for hiding this comment

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

Maybe adding an and would be more readable
"users can track their milestones and unlock badges for completing specific goals"

@tercierp tercierp merged commit 592b1e2 into main Dec 20, 2024
3 checks passed
@tercierp tercierp deleted the docs/update-readme branch December 20, 2024 00:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation 📄 Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update the README
2 participants