Skip to content

Commit e2a0dd3

Browse files
committed
chore: add comment how this module gets its information from .git folder
1 parent 92a6c85 commit e2a0dd3

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ commitInfo(folder)
3636

3737
Notes:
3838

39+
- 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)
3940
- Resolves with [Bluebird](https://github.com/petkaantonov/bluebird) promise.
4041
- Only uses Git commands, see [src/git-api.js](src/git-api.js)
4142
- If a command fails, returns null for each property

0 commit comments

Comments
 (0)