diff --git a/README.md b/README.md index d5ce1b0..cc64999 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,12 @@ # git-suggest-ownership -Tool that lists the files in a git repository that currently have lines that were changed by you. +CLI tool that lists the files in a git repository that currently have lines that were changed by you. Sorted by percentage of lines you changed for each file. -Useful to figure out what parts of the code you could be _codeowner_ for. \ No newline at end of file +Useful to figure out what parts of the code you could be _codeowner_ for. + +# Usage +```bash +cd pathtoyourrepo +git-suggest-ownership +``` \ No newline at end of file