readme

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.
+
+<img src="https://github.com/user-attachments/assets/352c1fa2-87f8-4565-b76a-32286eee7054" height="400" alt="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 🤖
+