From dd5ebb599f83124c5a0c8403d414e9b120ca98ab Mon Sep 17 00:00:00 2001 From: Matthew Jackson Date: Mon, 22 Jun 2026 16:53:14 -0700 Subject: [PATCH] docs: generic repo README; ld README keeps specifics + MakeMKV/Mike Chen credit --- README.md | 12 +++++------- ld/README.md | 6 +++++- 2 files changed, 10 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 9301eec..174a498 100644 --- a/README.md +++ b/README.md @@ -3,12 +3,12 @@ Unlocker plugins for [libfreemkv](https://github.com/freemkv/libfreemkv). libfreemkv ships only the pluggable `Unlocker` trait + registry and stays -firmware-clean — it contains no concrete firmware-unlock code. Each crate in -this workspace implements one unlocker and is registered into libfreemkv by a -single line in the consuming binary: +firmware-clean — it contains no concrete unlock code. Each crate in this +workspace implements one unlocker and is registered into libfreemkv by a single +line in the consuming binary: ```rust -libfreemkv::register_unlocker(Box::new(freemkv_unlock_ld::LibreDrive::new())); +libfreemkv::register_unlocker(Box::new(my_unlocker::MyUnlocker::new())); ``` Removing an unlocker is deleting that one line and the dependency @@ -16,8 +16,6 @@ Removing an unlocker is deleting that one line and the dependency ## Members -| Crate | Unlocker | -|-------|----------| -| [`ld`](ld/) (`freemkv-unlock-ld`) | LibreDrive — MediaTek MT1959 firmware unlock | +Each member is a self-contained unlocker plugin — see its own README for details. License: AGPL-3.0-only. diff --git a/ld/README.md b/ld/README.md index 1d5583a..8990ab7 100644 --- a/ld/README.md +++ b/ld/README.md @@ -46,5 +46,9 @@ step; it is **never** automated by freemkv. This crate only performs the non-persistent `#2` step — the microcode lives in RAM and is gone on power cycle. - +## Credits + +LibreDrive was created by **Mike Chen** and the **MakeMKV team**. This crate +builds on their work — our thanks and full credit to them for the LibreDrive +capabilities.