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: improve README #54

Merged
merged 1 commit into from
Mar 20, 2023
Merged

Conversation

lars-reimann
Copy link
Member

Closes #19.

Summary of Changes

See the issue for more details.

@lars-reimann lars-reimann linked an issue Mar 20, 2023 that may be closed by this pull request
5 tasks
@lars-reimann lars-reimann force-pushed the 19-improve-description-in-readme branch from 8a82da4 to a655f3a Compare March 20, 2023 21:55
@lars-reimann
Copy link
Member Author

lars-reimann commented Mar 20, 2023

🦙 MegaLinter status: ✅ SUCCESS

Descriptor Linter Files Fixed Errors Elapsed time
✅ MARKDOWN markdown-link-check 1 0 1.56s
✅ REPOSITORY git_diff yes no 0.02s

See detailed report in MegaLinter reports
Set VALIDATE_ALL_CODEBASE: true in mega-linter.yml to validate all sources, not only the diff

MegaLinter is graciously provided by OX Security

@lars-reimann lars-reimann force-pushed the 19-improve-description-in-readme branch 3 times, most recently from 9c73c6b to ba2b44f Compare March 20, 2023 22:14
@codecov
Copy link

codecov bot commented Mar 20, 2023

Codecov Report

Merging #54 (189a25c) into main (74b0753) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main      #54   +/-   ##
=======================================
  Coverage   91.51%   91.51%           
=======================================
  Files          45       45           
  Lines        1132     1132           
=======================================
  Hits         1036     1036           
  Misses         96       96           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@lars-reimann lars-reimann force-pushed the 19-improve-description-in-readme branch from ba2b44f to 189a25c Compare March 20, 2023 22:22
@lars-reimann lars-reimann changed the title docs: update README docs: improve README Mar 20, 2023
@lars-reimann lars-reimann merged commit c3fd3b5 into main Mar 20, 2023
@lars-reimann lars-reimann deleted the 19-improve-description-in-readme branch March 20, 2023 22:27
@lars-reimann
Copy link
Member Author

🎉 This PR is included in version 0.3.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@lars-reimann lars-reimann added the released Included in a release label Mar 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
released Included in a release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve description in README
1 participant