Skip to content

Commit 52dcac9

Browse files
committed
Update readme to contain new interval parameter.
Improve examples. [skip ci]
1 parent d38a3c3 commit 52dcac9

File tree

1 file changed

+25
-9
lines changed

1 file changed

+25
-9
lines changed

README.md

Lines changed: 25 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -53,32 +53,48 @@ a | **a**ction: The actual action to perform. (handle (default), set, un
5353
| **handle** executes the `getUpdates` method; **set** / **unset** / **reset** the Webhook.
5454
l | **l**oop: Number of seconds to loop the script for (used for getUpdates method).
5555
| This would be used mainly via CLI, to continually get updates for a certain period.
56+
i | **i**nterval: Number of seconds to wait between getUpdates requests (used for getUpdates method, default: 2).
57+
| This would be used mainly via CLI, to continually get updates for a certain period, every **i** seconds.
5658

5759
#### via browser
5860

5961
Simply point your browser to the `manager.php` file with the necessary **GET** parameters:
6062
`http://example.com/manager.php?s=<secret>&a=<action>&l=<loop>`
6163

62-
*e.g.* Set the webhook:
64+
**Webhook**
65+
Set, unset and reset the webhook:
6366
`http://example.com/manager.php?s=super_secret&a=set`
67+
`http://example.com/manager.php?s=super_secret&a=unset`
68+
`http://example.com/manager.php?s=super_secret&a=reset` (unset & set combined)
6469

65-
*e.g.* Handle updates for 30 seconds:
66-
`http://example.com/manager.php?s=super_secret&a=handle&l=30` or simply
67-
`http://example.com/manager.php?s=super_secret&l=30` (`handle` action is the default)
70+
**getUpdates**
71+
Handle updates once:
72+
`http://example.com/manager.php?s=super_secret&a=handle` or simply
73+
`http://example.com/manager.php?s=super_secret` (`handle` action is the default)
74+
75+
Handle updates for 30 seconds, fetching every 5 seconds:
76+
`http://example.com/manager.php?s=super_secret&l=30&i=5`
6877

6978
#### via CLI
7079

7180
When using CLI, the secret is not necessary (since it could just be read from the file itself).
7281

7382
Call the `manager.php` file directly using `php` and pass the parameters:
74-
`$ php manager.php a=<action> l=<loop>`
83+
`$ php manager.php a=<action> l=<loop> i=<interval>`
7584

76-
*e.g.* Set the webhook:
85+
**Webhook**
86+
Set, unset and reset the webhook:
7787
`$ php manager.php a=set`
88+
`$ php manager.php a=unset`
89+
`$ php manager.php a=reset` (unset & set combined)
90+
91+
**getUpdates**
92+
Handle updates once:
93+
`$ php manager.php a=handle` or simply
94+
`$ php manager.php` (`handle` action is the default)
7895

79-
*e.g.* Handle updates for 30 seconds:
80-
`$ php manager.php a=handle l=30` or simply
81-
`$ php manager.php l=30` (`handle` action is the default)
96+
Handle updates for 30 seconds, fetching every 5 seconds:
97+
`$ php manager.php l=30 i=5`
8298

8399
### Create the manager PHP file
84100

0 commit comments

Comments
 (0)