Skip to content

Commit 5e0ba49

Browse files
committed
update readme
1 parent aa9d787 commit 5e0ba49

File tree

1 file changed

+11
-14
lines changed

1 file changed

+11
-14
lines changed

README.md

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Create git activities from your commits.
1+
Keep your git statistics with post-commit hook.
22

33
---
44

@@ -49,23 +49,20 @@ $ tree
4949
└── log.yaml
5050

5151
# Example generated file content after some commits
52-
$ cat 2023/01/02/log.java
53-
System.out.println("7 insertion(s), 2 deletion(s)");
54-
System.out.println("59 insertion(s), 6 deletion(s)")
55-
System.out.println("9 insertion(s), 1 deletion(s)");
52+
$ cat 2023/01/02/log.go
53+
fmt.Println("02:42 24 insertion(s), 7 deletion(s)")
54+
fmt.Println("03:39 83 insertion(s), 11 deletion(s)")
55+
fmt.Println("03:41 67 insertion(s), 20 deletion(s)")
5656
```
5757

5858
#### TODO
59+
- [x] file type overwriting (`jsx=js`)
60+
- [x] content template with config
61+
- [ ] filename template with config
62+
- [ ] excluding file extensions
63+
- [ ] separating stat dirs like `personal/`, `work/`
64+
- [ ] custom vars in params and templates(`-vars="project=foo-api-gateway"`)
5965

60-
- [ ] Write better readme
61-
- [ ] File stat aliases: `yaml=yml,java=gradle,xml,properties`
62-
- [ ] commit, filename templates with config
63-
```shell
64-
-vars="project=foo-api-gateway"
65-
log_format="{project}: {insert_count} insertion(s), {delete_count} deletion(s)"
66-
```
67-
- [ ] Funny commit messages
68-
- [ ] Create os packages for homebrew,apt etc.
6966
----
7067

7168
License: MIT

0 commit comments

Comments
 (0)