From 873457402fb582b09481f7cf55bb94c24b681b78 Mon Sep 17 00:00:00 2001
From: ermisw <ermis.wieger@gmail.com>
Date: Fri, 9 Feb 2024 09:44:32 +0100
Subject: [PATCH] added readme

---
 Readme.md | 82 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 82 insertions(+)
 create mode 100644 Readme.md

diff --git a/Readme.md b/Readme.md
new file mode 100644
index 0000000..9de67ef
--- /dev/null
+++ b/Readme.md
@@ -0,0 +1,82 @@
+# BHOM Webhook for Derdack
+
+# Environment vars
+This project uses the following environment variables:
+
+| Name                          | Description                         | 
+| ----------------------------- | ------------------------------------| 
+|bhome_access_key           | generated bhom access key            |
+|bhome_access_secret_key           | generated bhom secret key            |
+
+
+environment varibales could also be set in .env File:
+
+```
+bhome_access_key=XXXXXXXXXXXXXXXXXXXXXXXXX
+bhome_access_secret_key=XXXXXXXXXXXXXXXXXXXX
+```
+
+
+# Pre-requisites
+- Install [Node.js](https://nodejs.org/en/) version 16.0.0
+
+
+# Getting started
+- Clone the repository
+```
+git clone  <gitea url> <project_name>
+```
+- Install dependencies
+```
+cd <project_name>
+npm install
+```
+- Build the project
+```
+npm run build
+```
+
+# Deploy to Enterprise Alert
+
+{PATH}/Enterprise Alert\ConnectorHost\OutboundWebhooks\{IntegrationName}
+
+# Default configuration
+```
+var defaultConfig = { 
+    "acknowledge": {
+        "active": true,
+        "note": "EA: Event was acknowledged by user {{user.username}} and owner set",
+        "body": {
+            "status": "ACK",
+            "user_assigned": "{{user.username}}"
+           }
+    },   
+    "close": {
+        "active": false,
+        "body": {
+            "eventIds": [
+                "{{alert.externalEventId}}"
+            ],
+            "slots": {
+              "notes": "EA: Event was close by user {{user.username}}"
+            }
+          }
+    }
+};
+```
+# Override default configuration
+
+Create a config.json file to override default settings.
+Every default setting can be overriden!
+
+Example: activate close response:
+
+```
+{
+    
+    "close": {
+        "active": true,
+    }
+}
+```
+