Skip to content

Commit 911be95

Browse files
authored
Merge pull request #7 from upstash/disclaimer
Add disclaimer section to README
2 parents 27d2a09 + a4d2239 commit 911be95

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,13 @@
1010

1111
`@upstash/lock` offers a distributed lock implementation using Upstash Redis.
1212

13+
### Disclaimer
14+
15+
Please use this lock implementation for efficiency purposes; for example to avoid doing an expensive work more than once or to perform a task _mostly_ once in a best-effort manner.
16+
Do not use it to guarantee correctness of your system; such as leader-election or for the tasks requiring _exactly_ once execution.
17+
18+
Upstash Redis uses async replication between replicas, and a lock can be acquired by multiple clients in case of a crash or network partition. Please read the post [How to do distributed locking](https://martin.kleppmann.com/2016/02/08/how-to-do-distributed-locking.html) by Martin Kleppman to learn more about the topic.
19+
1320
### Quick Start
1421

1522
NPM

0 commit comments

Comments
 (0)