diff --git a/README.md b/README.md index cc55e56..a64930e 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,17 @@ Windows kernel driver utilities library. -TBD +Work in progress, use with care 🔥 + +## About + +Static library containing some unconventional and undocumented kernel space goodies for the adventurous kernel hacker 🙂 Although I aim for stable code, I can not recommend it for production use; but it's mighty helpful in a lab environment to say the least! + +Most of the logic you find here has been discovered and provided by the fine folks listed in the credits section below, I merely touched it up and molded into an utilities library for easy consumption in your own kernel driver project. + +## Conventions + +Custom types are prefixed with an all upper case `DOMITO_` and functions are prefixed with a Pascal case `Domito` to avoid conflicts with any system-provided names. The word "domito" is latin for "to tame". ## Sources & 3rd party credits