Skip to content

Commit

Permalink
Merge pull request #1095 from wakatime/misc/project-map-usage
Browse files Browse the repository at this point in the history
  • Loading branch information
gandarez authored Sep 17, 2024
2 parents fdf4bd9 + c17fc72 commit 6aa54e7
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions USAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand All @@ -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]
Expand All @@ -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]
Expand Down

0 comments on commit 6aa54e7

Please sign in to comment.