Add NoPeek integration instructions to README.md

DE127 · Mar 23, 2024 · 453c239 · 453c239
1 parent 4943f15
commit 453c239
Showing 1 changed file with 91 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -61,10 +61,100 @@ NoPeek is a tool designed to safeguard all content on your website from being co
 ```bash
 # Clone this project
 $ git clone https://github.com/de127/nopeek
+```
 
-
+## 🚀 Quick Start
+
+1. **Download NoPeek:** Download NoPeek from the [Github repository](https://github.com/de127/nopeek).
+
+2. **Include NoPeek Files:** Copy NoPeek's JS files into your project directory.
+
+    ```html
+    <script type="text/javascript" src="/path/to/hotkeys.min.js"></script>
+    <script type="text/javascript" src="/path/to/devtools-detect.js"></script>
+    <script type="text/javascript" src="/path/to/NoPeek.js"></script>
+    ```
+
+3. **Enable NoPeek:** Insert the following code into your website to start using NoPeek.
+
+    ```html
+    <script>
+        var mdpNoPeek = { 
+            "selectAll": "on", 
+            "copy": "on", 
+            "cut": "on", 
+            "paste": "on", 
+            "save": "on", 
+            "viewSource": "on", 
+            "printPage": "on", 
+            "developerTool": "on", 
+            "windowBlur": "on", 
+            "tabHidden": "on", 
+            "readerMode": "on", 
+            "rightClick": "on", 
+            "rightClickImage": "on", 
+            "textSelection": "on", 
+            "imageDragging": "on" 
+        };
+    </script>
+    ```
+
+## 🛠️ Configuration
+
+You can customize NoPeek's settings by modifying the `mdpNoPeek` variable in the JavaScript code. Here are some available settings:
+
+- `"selectAll": "on"`: Enable selecting all content on the page.
+- `"copy": "on"`: Allow copying content.
+- `"cut": "on"`: Allow cutting content.
+- `"paste": "on"`: Allow pasting content.
+- `"save": "on"`: Allow saving the webpage.
+- `"viewSource": "on"`: Allow viewing the webpage source code.
+- `"printPage": "on"`: Allow printing the webpage.
+- and many more settings.
+
+## 📝 Example
+
+Below is an example of how to use NoPeek in a webpage:
+
+```html
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>Your Website Title</title>
+    <script type="text/javascript" src="/path/to/hotkeys.min.js"></script>
+    <script type="text/javascript" src="/path/to/devtools-detect.js"></script>
+    <script type="text/javascript" src="/path/to/NoPeek.js"></script>
+    <script>
+        var mdpNoPeek = { 
+            "selectAll": "on", 
+            "copy": "on", 
+            "cut": "on", 
+            "paste": "on", 
+            "save": "on", 
+            "viewSource": "on", 
+            "printPage": "on", 
+            "developerTool": "on", 
+            "windowBlur": "on", 
+            "tabHidden": "on", 
+            "readerMode": "on", 
+            "rightClick": "on", 
+            "rightClickImage": "on", 
+            "textSelection": "on", 
+            "imageDragging": "on" 
+        };
+    </script>
+</head>
+<body>
+    <!-- Your website content goes here -->
+</body>
+</html>
 ```
 
+## 🎉 Congratulations!
+
+You have successfully integrated and configured NoPeek for your website. Now, the content on your website will be protected from unauthorized copying or grabbing.
 ## 📝 License
 
 This project is under license from MIT. For more details, see the [LICENSE](LICENSE) file.