README: Add more description about the kind of data that nogit is suitable for

It's a bit of an odd use case, so it takes a fair amount of text to
capture it.

diff --git a/README b/README
index fcf7d32ae95ddf8855e64d1d06d1c3998500aa92..9c4c43665fcb3d5fc36246992cd47e519186e99f 100644 (file)
--- a/README
+++ b/README
@@ -9,6 +9,28 @@ collaborators to invoke git commands. Any time a user might invoke
 invokes "nogit sync". And the user will not be prompted to fill out a
 commit message or to resolve conflicts, etc.
 
+This is not intended as an alternative to git. If you're already using
+git, please continue to do so, (creating clean code history with
+detailed commit messages, etc.). Instead, nogit is intended for text
+files that you otherwise wouldn't have even put into git. And
+specifically, it's only suitable for text files where a naive "union
+merge" is the right thing. To be precise, a nogit merge will always
+silently give you "both sides" of any merge conflict, and will not
+provide any conflict markers, (it won't even indicate that any
+conflict happened). It also won't give any predictable behavior on the
+ordering of lines in cases like this. So if your data isn't safe
+against that kind of corruption, then you'll probably not want to use
+it with nogit.
+
+The original data for which nogit was invented for was a simple TODO
+list where different people were adding items they wanted to work on,
+then removing them when they completed them. These people wanted to
+keep each other informed about their activities, so they wanted to
+share items in a single file. But there was no functional significance
+to the order of items. Finally, it was unlikely that two people would
+edit any one item in two different ways, (and even if they did it
+would be trivial and painless to sort this out after the fact).
+
 Installation
 ============
 The nogit implementation is a simple bash script named "nogit". To