-
Notifications
You must be signed in to change notification settings - Fork 4
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
Update README #26
Update README #26
Conversation
This is a first attempt at providing a more complete documentation of the project. Some sections (e.g. synopsis) will likely be moved elsewhere at some point.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks! That was very helpful!
Here is a first wave of comments. Not so much on the README itself, but on the state of the implementation it is describing.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, I think it is a nice rework of the README.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks a lot for writing this. I have a few comments, that you might address,
- Hide implementation details (URL, URL-KEY, FILE-KEY) - Make use of git annex info
I think it is now ready to merge, but pinging @christian-monch to double-check. |
d492add
to
96219fc
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #26 +/- ##
==========================================
+ Coverage 91.52% 91.77% +0.24%
==========================================
Files 18 18
Lines 802 802
Branches 62 62
==========================================
+ Hits 734 736 +2
+ Misses 51 49 -2
Partials 17 17 ☔ View full report in Codecov by Sentry. |
a2214de
to
a8e0eb9
Compare
This is a first (but by no means final) attempt at providing a more complete documentation of the project. Some sections (e.g. synopsis) will likely be moved elsewhere at some point.