Update 'README.md'

This commit is contained in:
Jordan Koch 2018-11-19 12:12:56 -05:00
parent 09a31f7ac8
commit 98b9b432cf

View File

@ -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`
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
Then on IRC
NOTE: You can have up to 5 different devices configured for push. Replace device1 in the above command with device2 etc.
`/msg *status loadmod --type=user push`
Test to see if push notifications are working
/msg *push send test
## Configuration
`/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`