diff --git a/README.md b/README.md index 66e59ef..f1c29ea 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,9 @@ ldlm logo

-# ldlm +# LDLM -ldlm is a lightweight distributed lock manager implemented over gRPC and REST. +LDLM is a **L**ightweight **D**istributed **L**ock **M**anager implemented over gRPC and REST. ## Installation @@ -206,11 +206,11 @@ The first client that obtains the lock within the uptime of the LDLM server will ## Lock Keys -Lock keys are meant to detect when ldlm and a client are out of sync. They are not cryptographic. They are not secret. They are not meant to deter malicious users from releasing locks. +Lock keys are meant to detect when LDLM and a client are out of sync. They are not cryptographic. They are not secret. They are not meant to deter malicious users from releasing locks. ## ldlm-lock commands -The ldlm-lock command is used to manipulate locks in a running ldlm server on the CLI. See also `ldlm-lock -help`. +The ldlm-lock command is used to manipulate locks in a running LDLM server on the CLI. See also `ldlm-lock -help`. ### List Locks @@ -220,11 +220,11 @@ This prints a list of locks and their keys ### Force Unlocking -If a lock ever becomes deadlocked (this *should* not happen), you can unlock it by running the following on the same machine as a running ldlm server: +If a lock ever becomes deadlocked (this *should* not happen), you can unlock it by running the following on the same machine as a running LDLM server: ldlm-lock unlock -## Examples +## Use Cases ### Primary / Secondary Failover