Return from $rpc->eventloop() after 2 seconds instead of 10.

[irc/unrealircd/unrealircd-rpc-php.git] / README.md

diff --git a/README.md b/README.md
index 0e4d39c0a44695d4219333db332d8f7145949845..386f1dc652b3beec046bc08486d79bc1536fd454 100644 (file)
--- a/README.md
+++ b/README.md
@@ -4,17 +4,13 @@ UnrealIRCd RPC
 This allows PHP scripts to control [UnrealIRCd](https://www.unrealircd.org/)
 via the [JSON-RPC interface](https://www.unrealircd.org/docs/JSON-RPC).
 
-WARNING: Both the UnrealIRCd-side and this PHP library are under heavy
-development so major API breakages are likely, such as changing the
-function names, arguments that need to be passed and the way things
-are returned.
+This library is used by the
+[UnrealIRCd webpanel](https://github.com/unrealircd/unrealircd-webpanel/).
 
 If you are interested in helping out or would like to discuss API
-capabilities, join us at `#unreal-webpanel` at irc.unrealircd.org
+capabilities, join us at `#unreal-webpanel` at `irc.unrealircd.org`
 (IRC with TLS on port 6697).
 
-See also [Looking for webdevs to make UnrealIRCd webpanel](https://forums.unrealircd.org/viewtopic.php?t=9257).
-
 Installation
 ------------
 ```bash
@@ -23,9 +19,8 @@ composer require unrealircd/unrealircd-rpc:dev-main
 
 UnrealIRCd setup
 -----------------
-UnrealIRCd 6.0.5 is needed and you need to configure it as explained in
-https://www.unrealircd.org/docs/JSON-RPC.
-
+UnrealIRCd 6.0.6 or later is needed and you need to enable
+[JSON-RPC](https://www.unrealircd.org/docs/JSON-RPC) in it.
 After doing that, be sure to rehash the IRCd.
 
 Usage
@@ -39,25 +34,25 @@ For this example, create a file like `src/rpctest.php` with:
 
     $api_login = 'api:apiPASSWORD'; // same as in the rpc-user block in UnrealIRCd
 
-    $rpc = new UnrealIRCd\Connection("wss://127.0.0.1:8000/",
+    $rpc = new UnrealIRCd\Connection("wss://127.0.0.1:8600/",
                         $api_login,
                         Array("tls_verify"=>FALSE));
 
     $bans = $rpc->serverban()->getAll();
-    foreach ($bans->list as $ban)
+    foreach ($bans as $ban)
         echo "There's a $ban->type on $ban->name\n";
 
     $users = $rpc->user()->getAll();
-    foreach ($users->list as $user)
+    foreach ($users as $user)
         echo "User $user->name\n";
 
     $channels = $rpc->channel()->getAll();
-    foreach ($channels->list as $channel)
+    foreach ($channels as $channel)
         echo "Channel $channel->name ($channel->num_users user[s])\n";
 ```
-And then run it on the command line with `php src/rpctest.php`
+Then, run it on the command line with `php src/rpctest.php`
 
 If the example does not work, then make sure you have configured your
 UnrealIRCd correctly, with the same API username and password you use
-here, and with an allowed IP, and changing the `127.0.0.1:8000` too
+here, with an allowed IP, and changing the `wss://127.0.0.1:8600/` too
 if needed.