README: warn about broken git comparator

[alexkli]

Mentioning #52.

[github-actions]

🎉 Sizewatcher congratulates on the size improvement 📉:

   🎉 git -49.0% (401 kB => 204 kB)

✅ node_modules has no changes (46.8 MB)

Largest production node modules:

┌───────────────┬─────────────┬────────┐
│ name          │ children    │ size   │
├───────────────┼─────────────┼────────┤
│ @octokit/rest │ 35          │ 11.56M │
├───────────────┼─────────────┼────────┤
│ simple-git    │ 4           │ 0.86M  │
├───────────────┼─────────────┼────────┤
│ js-yaml       │ 3           │ 0.72M  │
├───────────────┼─────────────┼────────┤
│ glob          │ 12          │ 0.14M  │
├───────────────┼─────────────┼────────┤
│ tmp           │ 2           │ 0.13M  │
├───────────────┼─────────────┼────────┤
│ xbytes        │ 0           │ 0.06M  │
├───────────────┼─────────────┼────────┤
│ debug         │ 1           │ 0.05M  │
├───────────────┼─────────────┼────────┤
│ deepmerge     │ 0           │ 0.03M  │
├───────────────┼─────────────┼────────┤
│ require-dir   │ 0           │ 0.02M  │
├───────────────┼─────────────┼────────┤
│ du            │ 1           │ 0.01M  │
├───────────────┼─────────────┼────────┤
│ + 1 modules   │             │        │
├───────────────┼─────────────┼────────┤
│ 11 modules    │ 37 children │ 5.52M  │
└───────────────┴─────────────┴────────┘

✅ npm_package +0.5% (20.5 kB => 20.6 kB)

Package contents:

📦  @adobe/sizewatcher@1.2.1
=== Tarball Contents === 
11.3kB LICENSE                        
5.9kB  lib/checkout.js                
5.9kB  lib/compare.js                 
1.7kB  lib/config.js                  
3.9kB  lib/comparators/custom.js      
2.3kB  lib/comparators/git.js         
2.6kB  lib/github.js                  
743B   index.js                       
3.0kB  lib/comparators/node_modules.js
2.3kB  lib/comparators/npm_package.js 
3.9kB  lib/render.js                  
4.6kB  lib/report.js                  
2.6kB  lib/sizewatcher.js             
1.2kB  package.json                   
1.5kB  CHANGELOG.md                   
25.8kB README.md                      
=== Tarball Details === 
name:          @adobe/sizewatcher                      
version:       1.2.1                                   
package size:  20.6 kB                                 
unpacked size: 79.3 kB                                 
shasum:        cc7591570c97ed5308ba5acf8f598be1aa2a25a7
integrity:     sha512-RSFBsuxRVtuYt[...]B002kGXpRrr/w==
total files:   16

Notes

• PR branch: warn-about-52-in-readme @ 44a5af2
• Base branch: main
• Sizewatcher v1.2.1
• Effective Configuration:

limits:
  fail: 100%
  warn: 30%
  ok: '-10%'
report:
  githubComment: true
  githubStatus: false
comparators: {}

[github-actions]

🎉 Sizewatcher congratulates on the size improvement 📉:

   🎉 git -49.0% (401 kB => 204 kB)

✅ node_modules has no changes (46.8 MB)

Largest production node modules:

┌───────────────┬─────────────┬────────┐
│ name          │ children    │ size   │
├───────────────┼─────────────┼────────┤
│ @octokit/rest │ 35          │ 11.56M │
├───────────────┼─────────────┼────────┤
│ simple-git    │ 4           │ 0.86M  │
├───────────────┼─────────────┼────────┤
│ js-yaml       │ 3           │ 0.72M  │
├───────────────┼─────────────┼────────┤
│ glob          │ 12          │ 0.14M  │
├───────────────┼─────────────┼────────┤
│ tmp           │ 2           │ 0.13M  │
├───────────────┼─────────────┼────────┤
│ xbytes        │ 0           │ 0.06M  │
├───────────────┼─────────────┼────────┤
│ debug         │ 1           │ 0.05M  │
├───────────────┼─────────────┼────────┤
│ deepmerge     │ 0           │ 0.03M  │
├───────────────┼─────────────┼────────┤
│ require-dir   │ 0           │ 0.02M  │
├───────────────┼─────────────┼────────┤
│ du            │ 1           │ 0.01M  │
├───────────────┼─────────────┼────────┤
│ + 1 modules   │             │        │
├───────────────┼─────────────┼────────┤
│ 11 modules    │ 37 children │ 5.52M  │
└───────────────┴─────────────┴────────┘

✅ npm_package has no changes (20.6 kB)

Package contents:

📦  @adobe/sizewatcher@1.2.1
=== Tarball Contents === 
11.3kB LICENSE                        
5.9kB  lib/checkout.js                
5.9kB  lib/compare.js                 
1.7kB  lib/config.js                  
3.9kB  lib/comparators/custom.js      
2.3kB  lib/comparators/git.js         
2.6kB  lib/github.js                  
743B   index.js                       
3.0kB  lib/comparators/node_modules.js
2.3kB  lib/comparators/npm_package.js 
3.9kB  lib/render.js                  
4.6kB  lib/report.js                  
2.6kB  lib/sizewatcher.js             
1.2kB  package.json                   
1.5kB  CHANGELOG.md                   
25.8kB README.md                      
=== Tarball Details === 
name:          @adobe/sizewatcher                      
version:       1.2.1                                   
package size:  20.6 kB                                 
unpacked size: 79.3 kB                                 
shasum:        8a0a1038639a0bbf0e6b70da4ca0cd8bf0515f1b
integrity:     sha512-GqTzWbGm6UNtD[...]1txlc5se9fECQ==
total files:   16

Notes

• PR branch: warn-about-52-in-readme @ 44a5af2
• Base branch: main
• Sizewatcher v1.2.1
• Effective Configuration:

limits:
  fail: 100%
  warn: 30%
  ok: '-10%'
report:
  githubComment: true
  githubStatus: false
comparators: {}

[coveralls]

Coverage remained the same at 57.081% when pulling 87ddbd2 on warn-about-52-in-readme into e74e431 on main.