feat: updating docs and fixing import error

README.md

@@ -1 +1,14 @@
-# git-chfrq
+# git-chfrq
+
+## Installation
+```
+git clone git@github.com:fafnirZ/git-chkfrq.git
+cd git-chkfrq/
+
+pip3 install .
+```
+
+this should install the `git-chkfrq` command
+
+## Usage
+run `git-chkfrq` for some usage instructions and notes

git_chkfrq/cli.py

@@ -16,7 +16,16 @@ def main():
 
 
   if len(sys.argv) != 3:
-    print("Usage: python3 -m git-chfrq {path_to_repo} {date_expr}")
+    print("Usage: git-chkfrq {path_to_repo} {date_expr}")
+    example_str = (
+      "Example:\n"
+      " git-chkfrq ./ 9d\n"
+      " git-chkfrq ./ 1y\n\n"
+      "allowed date_expression regex: (-)?[0-9]+(d|m|y)\n"
+      "NOTE: it will always be a relative time from now to a point in the past\n"
+      "as you cannot compare with future commits that do not exist\n"
+    )
+    print(example_str)
     exit(1)
 
   # get where user is executing the script

git_chkfrq/utils.py

@@ -1,9 +1,10 @@
 import math
 import re
 from git.diff import Diff
-from pathlib import Path
 from datetime import datetime, timedelta
 from dateutil.relativedelta import relativedelta
+from git import Repo
+
 def continguous_zip(l: list):
   """generated by gpt
   

setup.py

@@ -10,7 +10,6 @@
     install_requires=[
         'GitPython',
         'python-dateutil',
-        'pathlib',
     ],
     entry_points={
         'console_scripts': [