aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJan200101 <sentrycraft123@gmail.com>2022-10-19 12:38:56 +0200
committerJan200101 <sentrycraft123@gmail.com>2022-10-19 12:38:56 +0200
commit9d3f2aec02fb7c8436bd44661320874f4580325f (patch)
tree5a2d60786f7cf4c91b69960c784728f8ba816bf5 /README.md
downloadBerryClient-9d3f2aec02fb7c8436bd44661320874f4580325f.tar.gz
BerryClient-9d3f2aec02fb7c8436bd44661320874f4580325f.zip
Initial Commit
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 22 insertions, 0 deletions
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