Improved ReadMe document for Waistline Android Software.
Repository
https://github.com/davidhealey/waistline
Linked Task Request
A task request wasn't made by the project owner however, I contacted the project owner publicly by opening an issue on Github and he accepted my service to work on his project in the areas I specified.
Overview
I offered to draft a new readme document for the project(Waistline app) which would include more details and also contain a privacy policy, disclaimer, about us and contact us all which would be compiled in a single document(ReadMe) and this idea was okay to the project owner.
I created a pull request after drafting the document and the project owner seemed okay with it but had issues with the images used insisting that they were large and the document needed minor tweaks. In line with the demand of the project owner I made changes to the image and went over the document again to remove typos and wrongly placed words.
Having met the PO's demands the pull request was merged with minor changes on markdown text styling.
Actual content
In the document created, I made improvements to the
- App's summary.
- Included some of the app's features.
- Re-wrote the app's privacy policy.
The new policy included details of how user information is collected and used, the information collected, security of the user's information, third-party service providers, and notification of privacy policy changes. - Disclaimer.
- About Us.
- Contact Us.
This is the link the full readme document I created.
Additional information
The document created, showed little or no signs of plagiarism when checked with grammarly and some other online plagiarism checkers thus proving that the document was originally created by me.
This is the link to the merged pull request created by me.