Browse Source

fix(README): cleanup lock documentation

accidently merged this without any review. Here are some more cleanups.
Brandon Philips 12 years ago
parent
commit
412f56f971
1 changed files with 15 additions and 15 deletions
  1. 15 15
      README.md

+ 15 - 15
README.md

@@ -873,45 +873,45 @@ An HTML dashboard can be found at `http://127.0.0.1:4001/mod/dashboard/```
 
 The Lock module implements a fair lock that can be used when lots of clients want access to a single resource.
 A lock can be associated with a name.
-The value is unique so if a lock tries to request a name that is already queued for a lock then it will find it and watch until that name obtains the lock.
+The name is unique so if a lock tries to request a name that is already queued for a lock then it will find it and watch until that name obtains the lock.
 If you lock the same name on a key from two separate curl sessions they'll both return at the same time.
 
 Here's the API:
 
-**Retrieve the current value for the "customer1" lock.**
+**Acquire a lock (with no name) for "customer1"**
 
 ```sh
-curl http://127.0.0.1:4001/mod/v2/lock/customer1
+curl -X POST http://127.0.0.1:4001/mod/v2/lock/customer1?ttl=60
 ```
 
-**Retrieve the current index for the "customer1" lock**
+**Acquire a lock for "customer1" that is associated with the name "bar"**
 
 ```sh
-curl http://127.0.0.1:4001/mod/v2/lock/customer1?field=index
+curl -X POST http://127.0.0.1:4001/mod/v2/lock/customer1?ttl=60 -d name=bar
 ```
 
-**Acquire a lock (with no value) for "customer1"**
+**Renew the TTL on the "customer1" lock for index 2**
 
 ```sh
-curl -X POST http://127.0.0.1:4001/mod/v2/lock/customer1?ttl=60
+curl -X PUT http://127.0.0.1:4001/mod/v2/lock/customer1?ttl=60 -d index=2
 ```
 
-**Acquire a lock for "customer1" that is associated with the value "bar"**
+**Renew the TTL on the "customer1" lock for name "customer1"**
 
 ```sh
-curl -X POST http://127.0.0.1:4001/mod/v2/lock/customer1?ttl=60 -d value=bar
+curl -X PUT http://127.0.0.1:4001/mod/v2/lock/customer1?ttl=60 -d name=bar
 ```
 
-**Renew the TTL on the "customer1" lock for index 2**
+**Retrieve the current name for the "customer1" lock.**
 
 ```sh
-curl -X PUT http://127.0.0.1:4001/mod/v2/lock/customer1?ttl=60 -d index=2
+curl http://127.0.0.1:4001/mod/v2/lock/customer1
 ```
 
-**Renew the TTL on the "customer1" lock for value "customer1"**
+**Retrieve the current index for the "customer1" lock**
 
 ```sh
-curl -X PUT http://127.0.0.1:4001/mod/v2/lock/customer1?ttl=60 -d value=bar
+curl http://127.0.0.1:4001/mod/v2/lock/customer1?field=index
 ```
 
 **Delete the "customer1" lock with the index 2**
@@ -920,10 +920,10 @@ curl -X PUT http://127.0.0.1:4001/mod/v2/lock/customer1?ttl=60 -d value=bar
 curl -X DELETE http://127.0.0.1:4001/mod/v2/lock/customer1?index=customer1
 ```
 
-**Delete the "customer1" lock with the value "bar"**
+**Delete the "customer1" lock with the name "bar"**
 
 ```sh
-curl -X DELETE http://127.0.0.1:4001/mod/v2/lock/customer1?value=bar
+curl -X DELETE http://127.0.0.1:4001/mod/v2/lock/customer1?name=bar
 ```
 
 ## Contributing