Update documentation #135
Merged
Update documentation #135
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Hi @EkaterineSheshelidze, thanks for the PR, it's a good occasion to review and extend the docs. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #135 +/- ##
=======================================
Coverage 99.09% 99.09%
=======================================
Files 8 8
Lines 880 880
=======================================
Hits 872 872
Misses 8 8 ☔ View full report in Codecov by Sentry. |
|
Hi @EkaterineSheshelidze, I just reviewed your changes and added my own modifications. I will complete the list of software using Htmldate later. Do you have anything to add? |
|
Hi @adbar, I don't have anything to add so far. The file looks good. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As part of my open source journey, I've made several improvements to the project's README file. #6
Updated and rephrased the Description, Features, Installation, Author, and Contributing sections for clarity and consistency. Added new sections like Usage Examples, Acknowledgements, and How it Works to improve the structure of the documentation and to showcase code's capabilities.
I'm a beginner in open source and welcome your feedback! Please feel free to suggest further improvements or ask any questions.