Skip to content

Commit 8cfd20f

Browse files
committed
README: add a brief summary
1 parent 1ba6afa commit 8cfd20f

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@ _Happy Git repositories are all alike; every unhappy Git repository is unhappy i
22

33
# git-sizer
44

5-
Is your Git repository busting at the seams?
5+
Is your Git repository bursting at the seams?
6+
7+
`git-sizer` computes various size metrics for a Git repository, flagging those that might cause you problems or inconvenience. For example:
68

79
* Is the repository too big overall? Ideally, Git repositories should be under 1 GiB, and (without special handling) they start to get unwieldy over 5 GiB. Big repositories take a long time to clone and repack, and take a lot of disk space. Suggestions:
810

@@ -60,7 +62,7 @@ Is your Git repository busting at the seams?
6062

6163
* Commits with gigantic log messages?
6264

63-
`git-sizer` computes a bunch of statistics about your repository that can help reveal all of the problems described above. These practices are not wrong per se, but the more that you stretch Git beyond its sweet spot, the less you will be able to enjoy Git's legendary speed and performance. Moreover, if your Git repository statistics seem out of proportion to your project size, you might be able to make your life easier by adjusting how you use Git.
65+
`git-sizer` computes many size-related statistics about your repository that can help reveal all of the problems described above. These practices are not wrong per se, but the more that you stretch Git beyond its sweet spot, the less you will be able to enjoy Git's legendary speed and performance. Especially if your Git repository statistics seem out of proportion to your project size, you might be able to make your life easier by adjusting how you use Git.
6466

6567

6668
## Getting started

0 commit comments

Comments
 (0)