From 034d6b105bccd0c1a966f0c0462910db4393f9d0 Mon Sep 17 00:00:00 2001
From: tpd94 <tpd94@cdm-project.com>
Date: Mon, 23 Sep 2024 21:30:25 +0000
Subject: [PATCH] Added README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9b4972e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,54 @@
+## Install
+1) Create a new python virtual environment using `python -m venv CDRM-Keys` or `python3 -m venv CDRM-Keys`
+2) Download / Git clone repository and extract the contents into the newly created virtual environment
+3) Change directory into the new CDRM-Keys folder
+4) Activate the virtual environment
+> Windows - call Script/activate.bat
+> 
+>  Linux - source bin/activate
+5) Run the application `python CDRM-Keys.py`
+
+
+## Proxy
+Proxy can be added in `Config.yaml` using the 2 letter country code. 
+```yaml
+Proxy: US
+```
+
+Reproxy support for https://chrome.pixelpenguinparade.org/api can be enabled by adding these lines to your `Config.yaml` for `CDRM-Keys`
+```yaml
+PPP:
+  api_key: YourAPIKey
+  api_url: https://chrome.pixelpenguinparade.org/api
+```
+
+Then starting the program and choosing
+> 1. CDRM-Keys API Mode
+> 2. PPP StreamFab API
+
+For Devine / VineTrimmer support add these lines to  `devine.yaml` or VineTrimmer equivalent 
+
+```yaml
+remote_cdm:
+    - name: "CDRM_Keys_API"
+      device_type: CHROME
+      system_id: 2710
+      security_level: 3
+      host: "http://127.0.0.1:5000/remote_cdm"
+      secret: "CDRM-Keys"
+      device_name: "PPP"
+cdm:
+   default: CDRM_Keys_API
+```
+
+For FoxRefire / CDM-Projects extension, add this to your `remote.json`
+```js
+{
+    "device_type": "CHROME",
+    "system_id": 2710,
+    "security_level":3,
+    "host": "http://127.0.0.1:5000/remote_cdm",
+    "secret": "CDRM-Keys",
+    "device_name": "PPP"
+}
+```
\ No newline at end of file