summaryrefslogtreecommitdiffstats
path: root/vendor/gix-lock/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/gix-lock/README.md')
-rw-r--r--vendor/gix-lock/README.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/vendor/gix-lock/README.md b/vendor/gix-lock/README.md
new file mode 100644
index 000000000..436b918ef
--- /dev/null
+++ b/vendor/gix-lock/README.md
@@ -0,0 +1,5 @@
+Use lock-files in the way git does with auto-cleanup being the most notable feature.
+
+* [x] writable lock files that can be committed to atomically replace the resource they lock
+* [x] read-only markers that lock a resource without the intend to overwrite it
+* [x] auto-removal of the lockfiles and intermediate directories on drop or on signal