more detailed README docs #224
Merged
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
including gotchas, errors and development instructions.
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.
These additions and tweaks to the docs (README.rst) come from common misunderstandings of the help output, and various quirks and potential bugs found in common backup implementations and my experience of using it for regular cron backups.
The goal of this update is to make it easier for noobs without having to look into the code, and to address some potential backup plan catastrophes resulting from basic misunderstandings/usages.
It's a pretty long addition but hopefully sectioned well. 🤓
(also improved the contributors call out and maintainer complete message too)