diff --git a/README.md b/README.md index 82c7f88..3c36a45 100644 --- a/README.md +++ b/README.md @@ -19,16 +19,59 @@ php -S localhost:8080 ## Usage +### Socket + +Check socket + +#### Usage + +* `port` required +* `host` optional, name, IPv4 or IPv6 (`REMOTE_ADDR` by default) + +``` +GET socket.php?port=80&host=php.net +``` + +##### Response + +``` +JSON +{ + status: bool +} +``` + ### Dig -#### Single record +Show host records + +#### Usage + +* `name` required host name, IPv4 or IPv6 +* `record` required if `records` not provided +* `records` required if `record` not provided + + [x] A + + [x] AAAA + + [ ] SRV #1 + +##### Single record ``` -dig.php?name=php.net&record=A +GET dig.php?name=php.net&record=A ``` -#### Multiple records +##### Multiple records ``` -dig.php?name=php.net&records[]=A&records[]=AAAA +GET dig.php?name=php.net&records[]=A&records[]=AAAA +``` + +##### Response + +``` +JSON +{ + status: bool + records: array +} ``` \ No newline at end of file