diff --git a/README.md b/README.md index 2ab74628f60ce2318984d65b089c692fcbd8a1b9..dc5bf1c3c46f8a86d13149e9a7be898fc30a8d73 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,8 @@ To uninstall, just type `pip uninstall auto_git_info` Basic usage ----- +##### Python module + ```python from auto_git_info import log_info import argparse @@ -38,6 +40,21 @@ The json file created will be: "time": "2023-06-23T18:04:30.894271"} ``` +##### Command line + +Just launch the auto_git_info module followed by your python script and its arguments +as usual. + +``` +python -m auto_git_info your_script.py args1 ... -optn argsn +``` + +or if you want to change the default path: + +``` +python -m auto_git_info log_info=path.json your_script.py args1 ... -optn argsn +``` +*Note that using this method will add `parsed_arguments=False` to the json* Advance usage -------------