From d77ba72070eb3bb035698a6b88f6ef2386704d79 Mon Sep 17 00:00:00 2001 From: Rahul Bansal Date: Mon, 22 Jul 2024 22:26:30 +0530 Subject: [PATCH] readme --- README.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..2826505 --- /dev/null +++ b/README.md @@ -0,0 +1,32 @@ +# PDF Unlocker App + +This is a menubar macos app designed to unlock encrypted PDF automatically using a known list of passwords. + +If you recieve encrypted PDFs such as bank/credit card/investment statements, you can store a list of their passwords in this app's settings. + +PDF Unlocker Settings + +Once you turn on "Start PDF Monitoring", it will keep running in the background and will automatically launch on next reboot. + +## Installation + +1. [Download PDF-Unlocker.zip](https://github.com/rahul286/PDF-Unlocker/releases/latest/download/PDF-Unlocker.zip) +2. Unzip file. It will show `PDF Unlocker.app`. +3. Drag and drop `PDF Unlocker.app` to your `Applications` folder. +4. Double click `PDF Unlocker.app` to launch menu bar app. +5. Click menu bar app icon to access settings to store password and start PDF monitoring. + + +## Known Issue + +- [] You need to quit and relaunch app after saving settings to start monitoring. +- [] Settings window sometimes doesn't come to front. Please check all windows. +- [] Fix menu bar icon size and likely swap it with app icon image + +## Credits + +* [LaunchAtLogin-Modern](https://github.com/sindresorhus/LaunchAtLogin-Modern) by sindresorhus +* [FileWatcher](https://github.com/eonist/FileWatcher) by eonist +* [Unlock App Icon](https://thenounproject.com/icon/unlock-89653/) by Noun Project +* ChatGPT and Gemini 🤖 +