From 478e1f385ad6949b52921a838b740fc387c9d300 Mon Sep 17 00:00:00 2001
From: Seth <48533968+WillCodeForCats@users.noreply.github.com>
Date: Sun, 30 Jul 2023 12:59:14 -0700
Subject: [PATCH] Create README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..05230f3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+# asterisk-contact-id
+asteriskcontactid.pl
+
+A Contact ID processor for Asterisk's AlarmReceiver() application.
+
+https://wiki.asterisk.org
+
+Uses rcell-smsclient for direct SMS notifications
+
+https://github.com/WillCodeForCats/rcell-smsclient
+
+## Installation
+* Copy asteriskcontactid.pl into /usr/local/bin
+* chmod 755 /usr/local/bin/asteriskcontactid.pl
+
+## Configuration
+asterisk.conf:
+* mindtmfduration = 40
+
+alarmreceiver.conf:
+* eventcmd = /usr/local/bin/asteriskcontactid.pl
+* eventspooldir = /var/spool/asterisk/alarmreceiver