From 897552862d19252d338deb7bace60c81fc3e6137 Mon Sep 17 00:00:00 2001
From: Rib <1957489+RibShark@users.noreply.github.com>
Date: Sat, 3 Feb 2024 20:02:59 +0000
Subject: [PATCH] Add readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..36da57c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,29 @@
+# SafeDiscShim
+## Disclaimer
+SafeDiscShim is purely designed as a compatibility tool: no security mechanisms are bypassed in the operation of this 
+tool and SafeDisc protected games still require their original discs in order to function, even when using this tool.
+Certain games may have additional compatibility issues outside of the SafeDisc protection; this tool makes no attempt to
+fix such issues. Due to the techniques used, certain anti-malware programs may wrongly detect this software as being
+malicious.
+
+## Introduction
+SafeDiscShim is a compatibility tool that allows for SafeDisc protected games which utilize the insecure Macrovision
+Security Driver ("secdrv.sys") to run on modern versions of Windows which have said driver blacklisted. Previous methods
+to restore functionality to these games relied on forcefully installing the driver, potentially opening security risks.
+
+In contrast, this tool does not rely on any drivers to function. Instead, it automatically loads alongside SafeDisc
+protected games and intercepts any communication requests that would have been sent to the driver, instead sending the 
+expected response itself and allowing the game to boot.
+
+## Installation Instructions
+Simply download the [latest release](https://github.com/RibShark/SafeDiscShim/releases/latest) and run the installer.
+Once installed, SafeDiscShim should automatically insert itself into most SafeDisc protected games.
+
+For a few games utilizing SafeDisc v1, SafeDiscShim may not work properly without first deleting the "drvmgt.dll" file
+that is located in the same folder as the game executable. If you find a game where this is the case, please write an 
+[issue report](https://github.com/RibShark/SafeDiscShim/issues) detailing the name and specific release of the game so
+a specific compatibility profile can be created to bypass the problem.
+
+## Logging
+To aid with debugging, beta versions of SafeDiscShim will automatically create log files in the same folder as the 
+executable. If you wish to disable this, set the environment variable "SAFEDISCSHIM_LOGLEVEL" with a value of "none".