From 98b9b432cf1e8e83ea11faf0708bad7e422274ba Mon Sep 17 00:00:00 2001 From: eskimo Date: Mon, 19 Nov 2018 12:12:56 -0500 Subject: [PATCH] Update 'README.md' --- README.md | 36 ++++++++++++++++++++---------------- 1 file changed, 20 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 475368f..ed76913 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,26 @@ -Compiling -NOTE: You may need need to change the ZNC module path. The example below is for ZNC systems configured from the Running ZNC as a system daemon section in the ZNC wiki. +## Building -Holo@znc:~$ curl -o ~/push.cpp https://znc.iglooirc.com/push.cpp -Holo@znc:~$ znc-buildmod push.cpp -Holo@znc:~$ sudo cp push.so /var/lib/znc/modules/ -Holo@znc:~$ rm ~/push.so -Holo@znc:~$ sudo systemctl restart znc.service -NOTE: If you are having problems compiling see the Compiling modules section in the ZNC wiki. +``` +git clone http://git.jordanko.ch/eskimo/Igloo-Push.git +cd Igloo-Push +znc-buildmod push.cpp +``` -Now, load the module in ZNC: +## Usage -/msg *status loadmod --type=user push +`mv push.so ~/.znc/modules` + +Then on IRC -Configuration -Once you have the device token copied (from settings inside Igloo), we need to set up the push service to send push notifications to the device. -/msg *push set device1 token +`/msg *status loadmod --type=user push` -NOTE: You can have up to 5 different devices configured for push. Replace device1 in the above command with device2 etc. +## Configuration -Test to see if push notifications are working -/msg *push send test \ No newline at end of file +`/msg *push set device1 token` + +* Replace device1 with device2-5 for additional devices +* Replace token with your push token from Settings in Igloo + +## Testing + +`/msg *push send test` \ No newline at end of file