aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2965917
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+## About
+A Perl script that wrapped some git command to get the updated-times (committed-times) from HEAD's tree for [git](https://git-scm.com/).
+
+## How to use
+
+```
+$ perl ./time-getter.pl
+```
+
+## ATTENTION
+On basically git concept, objects that have time state (_committer committed time_ and _author committed time_) is **ONLY** commit-objects.
+
+Probably this concept is itself intentionally, so **this wrapper script is expected to use in some cases as a workaround**.
+
+So if possible, you should consider another approach to the case before using this wrapper script.