diff --git a/README.md b/README.md index 3c5bf63..964f0fe 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,21 @@ This is a little utility I use for logging my daily activities and events. It is written in Python. -Go ahead, make fun of me because this is "cringe". Whatever. I have the basilisks ready to deploy at the snap of my fingers, so you best watch yourself. +Go ahead, make fun of me because this is "cringe". Whatever. I have the basilisks ready to deploy at the snap of my fingers, so you best watch yourself. 😾 ## Install -Clone this repo and copy the `elog` binary to PATH somewhere. +Clone this repo and copy the `elog` binary to PATH somewhere. +Also edit line 32 for your desired elog directory: + +```python +elog_dir = Path("~//elog").expanduser() +``` + +## Usage +![usage_screenshot.png](/usage_screenshot.png) + + +### Example list output ![screenshot.png](/screenshot.png) diff --git a/screenshot.png b/screenshot.png index 3db07aa..d5e0372 100644 Binary files a/screenshot.png and b/screenshot.png differ diff --git a/usage_screenshot.png b/usage_screenshot.png new file mode 100644 index 0000000..be82f28 Binary files /dev/null and b/usage_screenshot.png differ