From 9abc641b0405a222f09871bbb70dea8508980ff0 Mon Sep 17 00:00:00 2001 From: Dan Date: Sat, 21 Jan 2023 21:03:51 -0500 Subject: [PATCH] update readme for v1 --- README.md | 18 ++++++++++-------- composer.json | 4 ++-- 2 files changed, 12 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 13ac6d8..b7544d1 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,4 @@ # Whodis - Easy to use Whois client for PHP -# Danger: WIP - this project will eat your cat [![Latest Version](https://img.shields.io/github/release/php-http/package.svg?style=flat-square)](https://github.com/mallardduck/whodis/releases) [![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 @@ A simple to use high-level Whois client for PHP. -## TODO Before V1 -- Add result parsing features, -- Refactor lookup output to provide POPO of info, -- Allow output as plain text, or POPOs; maybe different methods? - ## Requirements * PHP >= 8.0 @@ -34,16 +28,24 @@ require __DIR__ . '/vendor/autoload.php'; use MallardDuck\Whodis\Whodis; $whodis = new Whodis(); -$response = $whodis->lookup('danpock.me'); -echo $response; // Prints the WHOIS results string, same as if you ran `whois danpock.me` in shell. +$response = $whodis->lookup('danpock.me', fullResults: true); +echo $response; // Prints WHOIS results identical to running `whois danpock.me` in shell*. ``` +> * = Varies based on CLI `whois` client, docs assume your client matches BSD `whois` which provides recursive results by default. + ## Testing ``` bash $ composer test ``` +> 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. + +## TODO Before V2 +- Add result parsing features, +- Refactor lookup output to provide POPO of info, +- Allow output as plain text, or POPOs; maybe different methods? ## Contributing diff --git a/composer.json b/composer.json index 98e6754..151474a 100644 --- a/composer.json +++ b/composer.json @@ -21,7 +21,7 @@ "require": { "php": "^8.0", "jeremykendall/php-domain-parser": "^6.1", - "mallardduck/whois-client": "dev-3.0-main", + "mallardduck/whois-client": "3.0.0", "mallardduck/whois-server-list": "^2.0", "symfony/polyfill-intl-idn": "^1.27" }, @@ -33,7 +33,7 @@ "phpstan/phpstan": "^1.9", "phpunit/phpunit": "^9.5", "squizlabs/php_codesniffer": "^3.6", - "symfony/var-dumper": "^6.2", + "symfony/var-dumper": "^5.4", "vimeo/psalm": "^5.0" }, "suggest": {