From c17fc7284d62ffbe1661f97fe3605f83e77df0d3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Carlos=20Henrique=20Guard=C3=A3o=20Gandarez?= Date: Mon, 16 Sep 2024 15:33:19 -0300 Subject: [PATCH] Improve docs for project map usage --- USAGE.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/USAGE.md b/USAGE.md index 30dfe773..2722b1e0 100644 --- a/USAGE.md +++ b/USAGE.md @@ -116,7 +116,7 @@ some/submodule/name = new project name ### Project Map Section -A key value pair list separated by new line. Use when a project should be renamed to another when sent to the API. +A key value pair list separated by new line, where the value before equal sign is the regex pattern and the latter is the override project name. Use when a project should be renamed to another when sent to the API. The order of the project map is important, the first match is used. Do not add any leading space before the regex pattern. ```ini [projectmap] @@ -126,7 +126,7 @@ projects/foo = new project name ### Project Api Key Section -A key value pair list separated by new line. Use when a project should be sent using another api key other than the default on `settings.api_key`. +A key value pair list separated by new line, where the value before equal sign is the regex pattern and the latter is the override api key. Use when a project should be sent using another api key other than the default on `settings.api_key`. The order of the project api key is important, the first match is used. Do not add any leading space before the regex pattern. ```ini [project_api_key] @@ -148,7 +148,7 @@ However, if an api key exists in your `~/.wakatime.cfg` file then it takes prece ### Git Submodule Project Map Section -A key value pair list separated by new line. Use when a submodule project should be renamed to another when sent to the API. +A key value pair list separated by new line, where the value before equal sign is the regex pattern and the latter is the override project name for submodule. Use when a submodule project should be renamed to another when sent to the API. The order of the git submodule project map is important, the first match is used. Do not add any leading space before the regex pattern. ```ini [git_submodule_projectmap]