]> jfr.im git - irc/unrealircd/unrealircd-rpc-php.git/commitdiff
Update the README a bit now that things have settled.
authorBram Matthys <redacted>
Sat, 25 Mar 2023 18:07:58 +0000 (19:07 +0100)
committerBram Matthys <redacted>
Sat, 25 Mar 2023 18:07:58 +0000 (19:07 +0100)
README.md

index 4c600cb04d1200eeb2e44a67690319c06efb76fa..27f9c068fb874030e09a3e17ef67194e67f7eec2 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 is used by the
+[https://github.com/unrealircd/unrealircd-webpanel/](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
 (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,8 +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 configure it as explained
+in https://www.unrealircd.org/docs/JSON-RPC.
 
 After doing that, be sure to rehash the IRCd.
 
@@ -39,7 +35,7 @@ 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));
 
@@ -59,5 +55,5 @@ And 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, and with an allowed IP, and changing the `127.0.0.1:8600` too
 if needed.