README

freckle · Nov 2, 2023 · b31a387 · b31a387
1 parent 0336fd8
commit b31a387
Showing 1 changed file with 5 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -24,10 +24,13 @@ Wait for, acquire, and release a distributed lock via S3 storage.
 - run: echo "Lock held, do work here"
 ```
 
-The lock is released in our Post step, or when it expires.
-
 ![](./screenshot.png)
 
+The lock is released (the S3 object deleted) in our Post step, which provides a
+pretty robust guarantee of release. Expired locks are ignored (not deleted), so
+it's recommended you put a Lifecyle policy on the Bucket to clean them up after
+some time.
+
 ## Inputs and Outputs
 
 See [action.yml](./action.yml) for a complete list of inputs and outputs.