From 533fe677de52845309c1b2b0cbe3b42b9f014548 Mon Sep 17 00:00:00 2001 From: Maksim Syomochkin Date: Mon, 6 Dec 2021 22:05:17 +0300 Subject: [PATCH] Update readme --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 00ca098..268c41b 100644 --- a/README.md +++ b/README.md @@ -1 +1,9 @@ -# gitcheck \ No newline at end of file +# Git User Check + +Sometimes, after cloning a repository from a corporate server and having already sent several commits there, you notice that you forgot to change the user settings in git. +This extension is written to avoid this. + +## Configuration +* `gitcheck.domain` – The domain (or just a substring) for which the check will be performed (you can see in the output of the command `git remote -v`)& +* `gitcheck.name` – This value will be checked against the value of the git parameter `user.name`. +* `gitcheck.email` – This value will be checked against the value of the git parameter `user.email`. \ No newline at end of file