Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve docs for project map usage #1095

Merged
merged 1 commit into from
Sep 17, 2024
Merged

Improve docs for project map usage #1095

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions USAGE.md
View file
Open in desktop
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
Loading