From 152d28686db36a13189d1db6c66b7855c905ecd9 Mon Sep 17 00:00:00 2001
From: knighttower <649334+knighttower@users.noreply.github.com>
Date: Tue, 12 Sep 2023 18:11:54 +0000
Subject: [PATCH] add test

---
 README.md          | 21 ++++++++++++++++++++-
 package.json       |  6 ++++--
 src/ProxyHelper.ts | 17 +++++++++++++++++
 3 files changed, 41 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index a81ee78..8fc07e4 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,21 @@
 # JsObjectProxyHelper
-Convert to proxy to protect objects
+Convert object to proxy to protect the objects
+
+``npm install @knighttower/js-object-proxy-helper``  
+
+``yarn add @knighttower/js-object-proxy-helper``  
+
+```css
+/**
+* @module ProxyHelper
+* Convert to proxy to protect objects
+* Allows to declare _private, _protected and _mutable all arrays with prop names
+* @example ProxyHelper({objectProps..., _protected: array(...)})
+* @param {Object} object
+* @return {Proxy}
+* @usage const proxy = ProxyHelper({objectProps..., _protected: array(...), _private: array(...), _mutable: array(...)})
+* @usage _protected: array(...) -> Cannot be modified
+* @usage _private: array(...) -> Cannot be accessed
+* @usage _mutable: array(...) -> Can be modified
+*/
+```
\ No newline at end of file
diff --git a/package.json b/package.json
index 28a7ef7..fe27283 100644
--- a/package.json
+++ b/package.json
@@ -1,8 +1,10 @@
 {
     "name": "@knighttower/js-object-proxy-helper",
     "version": "1.0.1",
-    "main": "./src/ProxyHelper.ts",
-    "browser": "./dist/ProxyHelper.js",
+    "main": "src/ProxyHelper.ts",
+    "jsdeliver": "dist/ProxyHelper.js",
+    "unpkg": "dist/ProxyHelper.js",
+    "browser": "dist/ProxyHelper.js",
     "license": "MIT",
     "description": "Convert Object to proxy to protect the objects",
     "homepage": "https://github.com/knighttower/JsObjectProxyHelper",
diff --git a/src/ProxyHelper.ts b/src/ProxyHelper.ts
index 05d5a3e..79623b1 100644
--- a/src/ProxyHelper.ts
+++ b/src/ProxyHelper.ts
@@ -5,6 +5,23 @@ type ProxyHelperConfig = {
   [key: string]: any
 };
 
+/* Author Knighttower
+    MIT License
+    [2023] [Knighttower] https://github.com/knighttower
+*/
+
+/**
+* @module ProxyHelper
+* Convert to proxy to protect objects
+* Allows to declare _private, _protected and _mutable all arrays with prop names
+* @example ProxyHelper({objectProps..., _protected: array(...)})
+* @param {Object} object
+* @return {Proxy}
+* @usage const proxy = ProxyHelper({objectProps..., _protected: array(...), _private: array(...), _mutable: array(...)})
+* @usage _protected: array(...) -> Cannot be modified
+* @usage _private: array(...) -> Cannot be accessed
+* @usage _mutable: array(...) -> Can be modified
+*/
 export default function ProxyHelper(object: ProxyHelperConfig): ProxyHelperConfig {
   'use strict';