chore: add comment how this module gets its information from .git folder

cypress-io · Nov 27, 2018 · e2a0dd3 · e2a0dd3
1 parent 92a6c85
commit e2a0dd3
Showing 1 changed file with 1 addition and 0 deletions.
diff --git a/README.md b/README.md
@@ -36,6 +36,7 @@ commitInfo(folder)
 
 Notes:
 
+- Code assumes there is `.git` folder and uses Git commands to get each property, like `git show -s --pretty=%B`, see [src/git-api.js](src/git-api.js)
 - Resolves with [Bluebird](https://github.com/petkaantonov/bluebird) promise.
 - Only uses Git commands, see [src/git-api.js](src/git-api.js)
 - If a command fails, returns null for each property