Skip to content

Commit 9abc641

Browse files
committed
update readme for v1
1 parent 75a6651 commit 9abc641

File tree

2 files changed

+12
-10
lines changed

2 files changed

+12
-10
lines changed

README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
# Whodis - Easy to use Whois client for PHP
2-
# Danger: WIP - this project will eat your cat
32

43
[![Latest Version](https://img.shields.io/github/release/php-http/package.svg?style=flat-square)](https://github.com/mallardduck/whodis/releases)
54
[![Total Downloads](https://img.shields.io/packagist/dt/php-http/package.svg?style=flat-square)](https://packagist.org/packages/mallardduck/whodis)
@@ -8,11 +7,6 @@
87

98
A simple to use high-level Whois client for PHP.
109

11-
## TODO Before V1
12-
- Add result parsing features,
13-
- Refactor lookup output to provide POPO of info,
14-
- Allow output as plain text, or POPOs; maybe different methods?
15-
1610
## Requirements
1711
* PHP >= 8.0
1812

@@ -34,16 +28,24 @@ require __DIR__ . '/vendor/autoload.php';
3428
use MallardDuck\Whodis\Whodis;
3529

3630
$whodis = new Whodis();
37-
$response = $whodis->lookup('danpock.me');
38-
echo $response; // Prints the WHOIS results string, same as if you ran `whois danpock.me` in shell.
31+
$response = $whodis->lookup('danpock.me', fullResults: true);
32+
echo $response; // Prints WHOIS results identical to running `whois danpock.me` in shell*.
3933
```
4034

35+
> * = Varies based on CLI `whois` client, docs assume your client matches BSD `whois` which provides recursive results by default.
36+
4137
## Testing
4238

4339
``` bash
4440
$ composer test
4541
```
4642

43+
> Note: Due to how fast PHP tests run false-negatives can spawn. Whois servers may disconnect during a test resulting in empty response and failing tests.
44+
45+
## TODO Before V2
46+
- Add result parsing features,
47+
- Refactor lookup output to provide POPO of info,
48+
- Allow output as plain text, or POPOs; maybe different methods?
4749

4850
## Contributing
4951

composer.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
"require": {
2222
"php": "^8.0",
2323
"jeremykendall/php-domain-parser": "^6.1",
24-
"mallardduck/whois-client": "dev-3.0-main",
24+
"mallardduck/whois-client": "3.0.0",
2525
"mallardduck/whois-server-list": "^2.0",
2626
"symfony/polyfill-intl-idn": "^1.27"
2727
},
@@ -33,7 +33,7 @@
3333
"phpstan/phpstan": "^1.9",
3434
"phpunit/phpunit": "^9.5",
3535
"squizlabs/php_codesniffer": "^3.6",
36-
"symfony/var-dumper": "^6.2",
36+
"symfony/var-dumper": "^5.4",
3737
"vimeo/psalm": "^5.0"
3838
},
3939
"suggest": {

0 commit comments

Comments
 (0)