add note on winregistry kwarg

keygen-sh · Oct 6, 2023 · 66a93fb · 66a93fb
1 parent ad809a6
commit 66a93fb
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -44,6 +44,12 @@ print(machineid.hashed_id('myappid'))
 print(machineid.hashed_id())
 ```
 
+Both `id()` and `hashed_id()` accept a `winregistry: bool` kwarg,
+which can be used to disable a registry query on Windows (enabled
+by default). Depending on your security posture, disabling the
+registry query may help prevent machine fingerprints from
+being manually modified by a bad actor.
+
 ## Testing
 
 To run tests, invoke `unittest`: