Update docs

sorenlouv · Apr 25, 2020 · 2ab226a · 2ab226a
1 parent b69c4e9
commit 2ab226a
Showing 1 changed file with 16 additions and 4 deletions.
diff --git a/docs/configuration.md b/docs/configuration.md
@@ -56,7 +56,13 @@ Example:
 ```json
 {
  "upstream": "elastic/kibana",
- "branches": [{ "name": "6.x", "checked": true }, "6.3", "6.2", "6.1", "6.0"],
+ "targetBranchChoices": [
+ { "name": "6.x", "checked": true },
+ "6.3",
+ "6.2",
+ "6.1",
+ "6.0"
+ ],
  "targetPRLabels": ["backport"]
 }
 ```
@@ -75,17 +81,23 @@ Config:
 }
 ```
 
-#### `branches` **required**
+#### `targetBranchChoices` **required**
 
-List of branches that will be available to backport to. The array can contain branch names as strings or objects that also contains the field `checked` which indicates whether the branch should be pre-selected. It is useful to pre-select branches you often backport to.
+List of target branches the user can interactively select. The array can contain branch names as strings or objects that also contains the field `checked` which indicates whether the branch should be pre-selected. It is useful to pre-select branches you often backport to.
 
 CLI: `--branch 6.1 --branch 6.0`
 
 Config:
 
 ```json
 {
- "branches": [{ "name": "6.x", "checked": true }, "6.3", "6.2", "6.1", "6.0"]
+ "targetBranchChoices": [
+ { "name": "6.x", "checked": true },
+ "6.3",
+ "6.2",
+ "6.1",
+ "6.0"
+ ]
 }
 ```