# Locket

Locket is a distributed locking service and client libraries to
integrate with the service.

> \[!NOTE\]
>
> This repository should be imported as `code.cloudfoundry.org/locket`.

# Docs

-   [Understanding Locks and
    Presences](./docs/010-locks-and-presences.md)
-   [Locket Client](./docs/011-client.md)
-   [How Locket is using a
    database](./docs/020-how-locket-is-using-database.md)
-   [Using cfdot with
    Locket](./docs/030-using-cfdot-to-interact-with-locket.md)
-   [Common failure scenarios](./docs/040-common-failure-scenarios.md)
-   [Low-level Architecture](./docs/050-low-level-architecture.md)

# Contributing

See the [Contributing.md](./.github/CONTRIBUTING.md) for more
information on how to contribute.

# Working Group Charter

This repository is maintained by [App Runtime
Platform](https://github.com/cloudfoundry/community/blob/main/toc/working-groups/app-runtime-platform.md)
under `Diego` area.

> \[!IMPORTANT\]
>
> Content in this file is managed by the [CI task
> `sync-readme`](https://github.com/cloudfoundry/wg-app-platform-runtime-ci/blob/main/shared/tasks/sync-readme/metadata.yml)
> and is generated by CI following a convention.
