Nosial/socialbox-standard
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add RPC example to README

Browse source
This commit is contained in:
netkas 2024-09-02 20:34:47 -04:00
parent 77228532a0
commit f74977afe6
1 changed files with 8 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
README.md
View file

@ -117,7 +117,7 @@ example.com. IN TXT "socialbox=socialbox.example.com"
``` ```
Here, socialbox is the key, and the value is the URL of the Socialbox instance. The client resolves the main domain to Here, socialbox is the key, and the value is the URL of the Socialbox instance. The client resolves the main domain to
retrieve the TXT record, which then provides the URL of the Socialbox server.The client uses this URL to establish a retrieve the TXT record, which then provides the URL of the Socialbox server. The client uses this URL to establish a
connection to the Socialbox server. This process allows the client to dynamically discover the server URL. connection to the Socialbox server. This process allows the client to dynamically discover the server URL.
The domain name is usually resolved from a given peer address. The domain name is usually resolved from a given peer address.
@ -406,6 +406,13 @@ Ping allows you to test the connection to the server, this method doesn't accept
> Returns: Boolean (true) > Returns: Boolean (true)
RPC Example:
```text
SEND: {"id": "3bb935c6", "method": "ping"}
REC: {"id": "3bb935c6", "result": true}
```
## Protected ## Protected