Merge pull request #424 from gstackio/clarify-sentence

Clarify sentence when 'branch' is not set in source config
concourse · Mar 16, 2024 · a7587c9 · a7587c9
2 parents 06d08fc + 2eb2e23
commit a7587c9
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -6,8 +6,10 @@ Tracks the commits in a [git](http://git-scm.com/) repository.
 
 * `uri`: *Required.* The location of the repository.
 
-* `branch`: The branch to track. This is *optional* if the resource is
-   only used in `get` steps; however, it is *required* when used in a `put` step. If unset for `get`, the repository's default branch is used; usually `master` but [could be different](https://help.github.com/articles/setting-the-default-branch/).
+* `branch`: The branch to track. This is *optional* if the resource is only
+   used in `get` steps; however, it is *required* when used in a `put` step.
+   If unset, `get` steps will checkout the repository's default branch;
+   usually `master` but [could be different](https://help.github.com/articles/setting-the-default-branch/).
 
 * `private_key`: *Optional.* Private key to use when pulling/pushing.
     Example: