From d4d91691fba5b9af284b4334315033272d20dc0b Mon Sep 17 00:00:00 2001
From: kuuuube <hexagonisalie@gmail.com>
Date: Sun, 22 Mar 2026 02:13:36 -0400
Subject: [PATCH] Add start of dev docs

---
 README.md   |  2 ++
 dev_docs.md | 35 +++++++++++++++++++++++++++++++++++
 2 files changed, 37 insertions(+)
 create mode 100644 dev_docs.md

diff --git a/README.md b/README.md
index 6149965..e2877ba 100644
--- a/README.md
+++ b/README.md
@@ -62,3 +62,5 @@ For those who want to build the project from source:
 - Run `build.ps1` in the root directory
 
 The binaries will be in `build`.
+
+## [Dev Docs](./dev_docs.md)
diff --git a/dev_docs.md b/dev_docs.md
new file mode 100644
index 0000000..4023e90
--- /dev/null
+++ b/dev_docs.md
@@ -0,0 +1,35 @@
+## Config Files
+
+All config attributes are optional. Any omitted attributes will be ignored when matching.
+
+### `device_identifiers.json`
+
+- `friendly_name`: Displayed to user, not matched against
+- `device_desc`: Regex match (`Device Description` in pnputil_devices dump)
+- `manufacturer`: Regex match (`Manufacturer Name` in pnputil_devices dump)
+- `hardware_id`: Regex match (`Instance ID` in pnputil_devices dump)
+- `class_uuid`: Exact string match (`Class GUID` in pnputil_devices dump)
+- `inf_provider`: Regex match (`Provider Name` in pnputil_devices dump)
+
+### `driver_identifiers.json`
+
+- `friendly_name`: Displayed to user, not matched against
+- `original_name`: Regex match (`Original Name` in pnputil_drivers dump)
+- `provider`: Regex match (`Provider Name` in pnputil_drivers dump)
+- `class`: Exact string match (`Class GUID` in pnputil_drivers dump)
+
+### `driver_package_identifiers.json`
+
+- `friendly_name`: Displayed to user, not matched against
+- `display_name`: Regex match
+- `display_version`: Regex match
+- `publisher`: Regex match
+- `uninstall_method`: `Normal|Deferred|RegistryOnly`
+
+## Github Release Instructions
+
+- Set the new version in `Cargo.toml` and let it propagate to `Cargo.lock`.
+- PR and merge the version bump change.
+- Push a tag with the new version and a draft release will be created.
+- Review the draft and set it to latest if it looks good.
+- A PR will be automatically created to pull the latest changes from `main` into the config branch.