From 9d3f2aec02fb7c8436bd44661320874f4580325f Mon Sep 17 00:00:00 2001
From: Jan200101 <sentrycraft123@gmail.com>
Date: Wed, 19 Oct 2022 12:38:56 +0200
Subject: Initial Commit

---
 README.md | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a8c167c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+# unixreg
+
+## why
+While working on porting a python application to Linux I came across many uses of winreg that could not easily be ported over.
+
+Instead of reworking the system I decided to implement a bandaid solution that deals with it transparently.
+
+## how to use
+Update your winreg imports with this
+
+```py
+try:
+    import winreg
+except ImportError:
+    import unixreg as winreg
+```
+
+simply importing unixreg should be enough though, winreg is imported if found
+
+## license
+this project is licensed under the [MIT License](LICENSE)  
+feel free to do whatever you want with it
-- 
cgit v1.2.3