Safe onResume override to handle device wake-up, Removed unlocked notification, and formatted README

.luarc.json

@@ -0,0 +1,9 @@
+{
+  "$schema": "https://raw.githubusercontent.com/LuaLS/vscode-lua/master/setting/schema.json",
+  "workspace.library": [
+    "~/koreader-base/ffi",
+    "~/koreader/frontend"
+  ],
+  "runtime.version": "LuaJIT",
+  "hint.enable": false
+}

README.md

@@ -1,16 +1,61 @@
-# screenlock_koreader_plugin
-This is a small plugin to enable locking the screen of the KOReader.
+# KOReader Plugin: ScreenLock
 
-## Setup
-1. Put `screenlock.koplugin` into the `kodreader/plugins` directory.
-2. Change the hardcoded password at the top of the main.lua from 1234 to something else.
+This plugin adds a simple pin-based lock screen to KOReader.
 
-The plugin will automatically activate on resume from suspend. There is also a screenlock menu entry added.
+> [!CAUTION]  
+> This plugin provides **basic protection only**.  
+> It is **not a security solution** and will not stop a determined or technically skilled attacker.  
+> Do not rely on it to protect sensitive data.
 
-### Hide Content Feature
-Change `hide_content` bool to `true` to enlarge the input box and hide the screen until the password is entered correctly. This stops unauthorized users from seeing what books you're reading even if they turn on the device. Set bool to `false` to return to the small password box.
+## Features
 
-> [!CAUTION]  
-> This plugin is made for basic protection, not security — it may not protect your device from an experienced attacker.
->
-> Always keep your device out of the hands of real threats.
+- Lock KOReader with a password
+- Automatically locks after device suspend / resume
+- Optional blank (white) screen to hide document contents
+- On-screen password keyboard
+- Menu actions for locking and password management
+
+## Installation
+
+1. Copy the `screenlock.koplugin` folder into:
+   ```
+   koreader/plugins/
+   ```
+2. Start (or restart) KOReader.
+3. Open the KOReader menu and select **ScreenLock**.
+
+## Usage
+
+### Lock the screen
+
+- Open the KOReader menu
+- Go to **ScreenLock**
+- Select **Lock now**
+
+> or
+
+- Press power/lock button
+
+### Change the password
+
+- Open **ScreenLock** in the menu
+- Select **Change password**
+- Enter your current password, then set a new one
+
+> **Default password:** `1234`
+
+## Behavior Notes
+
+- The lock screen **automatically activates when the device resumes from sleep**
+- Pressing **Cancel** on the password prompt puts the device back to sleep
+- If enabled, screen contents are hidden while locked
+
+## Preview
+
+<img src=".github/assets/preview-pin.png" height="500"/>
+
+## Limitations
+
+- This plugin does **not encrypt files or memory**
+- It only protects access within KOReader
+- Removing the plugin or editing settings files can bypass the lock

screenlock.koplugin/_meta.lua

@@ -3,7 +3,6 @@ local _ = require("gettext")
 return {
     name = "screenlock",
     fullname = _("ScreenLock"),
-    description = _([[This plugin lets you lock your screen with a password, 
+    description = _([[This plugin lets you lock your screen with a password,
 either triggered from the menu or automatically upon device wake-up.]]),
 }
-