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

chore: update README.md #4866

Merged
merged 5 commits into from
Oct 16, 2022
Merged

chore: update README.md #4866

merged 5 commits into from
Oct 16, 2022

Conversation

utkarsh006
Copy link
Contributor

@utkarsh006 utkarsh006 commented Oct 15, 2022

Description

  • Updated README.md for better readability of users.
  • Formatted lines of README.
  • Shorten the README, so that users can interact with it for longer periods of time.
  • Added contributors section.
  • Highlighted important text.

Related issues #4865

Related PRs #4866

Screenshots

Screenshot (192)
Screenshot (188)
Screenshot (189)
Screenshot (190)
Screenshot (191)

Link to the automatically generated build APK

@utkarsh006 utkarsh006 requested a review from a team as a code owner October 15, 2022 15:16
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@utkarsh006
Copy link
Contributor Author

@VaiTon I have made the changes. Kindly look into them.

@utkarsh006 utkarsh006 requested a review from VaiTon October 16, 2022 19:18
@VaiTon
Copy link
Member

VaiTon commented Oct 16, 2022

Hey @utkarsh006, I left another comment

@utkarsh006
Copy link
Contributor Author

Hey @utkarsh006, I left another comment

Should I leave contributors section as it was earlier?

@utkarsh006
Copy link
Contributor Author

utkarsh006 commented Oct 16, 2022

@VaiTon I have done the changes told by you. Left the contributors section in its previous state. Do Review.

@VaiTon
Copy link
Member

VaiTon commented Oct 16, 2022

@utkarsh006 you can also add the contributors, I just commented about the original author being out of the contributors section

@utkarsh006
Copy link
Contributor Author

@utkarsh006 you can also add the contributors, I just commented about the original author being out of the contributors section

Finally done all the tasks. Hope, PR gets merged.

@VaiTon VaiTon changed the title Update README.md chore: update README.md Oct 16, 2022
@utkarsh006
Copy link
Contributor Author

@teolemon Kindly review my PR.

@VaiTon VaiTon merged commit 45def66 into openfoodfacts:develop Oct 16, 2022
@sonarqubecloud
Copy link

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

@utkarsh006 utkarsh006 deleted the ReadmeUtkarsh branch October 16, 2022 20:27
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