ubuntu / authd

Authentication daemon for external Brokers
GNU Lesser General Public License v3.0
110 stars 9 forks source link

docs: improve readme #510

Closed edibotopic closed 2 months ago

edibotopic commented 2 months ago

Attempts to improve the readme by providing:

When reading, a user should get a more immediate sense of what the product offers and where more technical information can be found, including information on architecture, etc.

UDENG-4080 UDENG-4083

codecov-commenter commented 2 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 84.78%. Comparing base (924b003) to head (aaa066b). Report is 2 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #510 +/- ## ========================================== - Coverage 84.84% 84.78% -0.06% ========================================== Files 79 79 Lines 6942 6942 Branches 75 75 ========================================== - Hits 5890 5886 -4 - Misses 736 737 +1 - Partials 316 319 +3 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

edibotopic commented 2 months ago

Thanks for these changes. I added a couple of comments though.

Much thanks @jibel . All of your improvements were incorporated in: https://github.com/ubuntu/authd/pull/510/commits/8960da7113502f026339a468bc30337424ee33c8