daniel-stoneuk / material-about-library

Makes it easy to create beautiful about screens for your apps
Apache License 2.0
1.12k stars 140 forks source link

Update Documentation - Improve Consistency #73

Closed code-schreiber closed 6 years ago

code-schreiber commented 6 years ago

Hello there Daniel, let me start by thanking you for your contribution to the android open source community. I found your library and it totally met my needs, after implementing it in an app I would like to contribute back, starting by updating the docs.

While trying to use material-about-library for the first time I found some inconsistencies in the setup part of the readme file that confused me a little, this is the main concern of this PR, I want to help making the setup process as smooth as possible.

I tried to make my decisions very clear by doing very small commits, feel welcome to suggest changes and even make those changes directly, I'm allowing edits from maintainers.

On a side note, I noticed that there is duplicated documentation in the Wiki that should probably be reviewed and merged into one single place.

daniel-stoneuk commented 6 years ago

Hi, thanks very much for doing all this! I hadn't got round to updating the documentation for the newer versions of the library so it's really appreciated.

Let me know which applications of yours include the library.

code-schreiber commented 6 years ago

No big deal 👍 That's one of the reasons I enjoy open source, because the work load can be distributed :)

The app that currently uses the library is Quick Code, an open source app to save and show QR codes.