Skip to content

Commit

Permalink
improve readme
Browse files Browse the repository at this point in the history
  • Loading branch information
gilbsgilbs committed Oct 7, 2020
1 parent edac271 commit f101d17
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,16 @@
# Glloq

Glloq is a simple command line utility and gorm library that lets you
take an advisory lock before running some action. This is especially useful
when you want to avoid running database migrations (for example) concurrently.
Glloq is a simple command line utility and Go library that lets you take an advisory lock on
various backends before running some action. This is especially useful when you want to avoid
running database migrations (for example) concurrently.

Officially supported backends currently include:

- PostgreSQL and derivatives (CockroachDB, …)
- MySQL and derivatives (MariaDB, …)
- Local files

but you can very easily implement your own.

## Usage

Expand Down

0 comments on commit f101d17

Please sign in to comment.