From f101d17f5ef126c66b7f128e61a55a66868c543d Mon Sep 17 00:00:00 2001 From: Gilbert Gilb's Date: Wed, 7 Oct 2020 20:50:10 +0200 Subject: [PATCH] improve readme --- README.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 96ad5e2..f521281 100644 --- a/README.md +++ b/README.md @@ -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