Information on how NTLM could be made to work

Author: SharkMachine

README.md

@@ -47,3 +47,12 @@ You can pass custom curl options to the client with `$curlOptions` constructor p
 - `CURLOPT_HEADER` - Headers are set in the request.
 - `CURLOPT_WRITEFUNCTION` - The client uses this to get the response body.
 - `CURLOPT_HEADERFUNCTION` - The client uses this to get the response headers.
+
+## How do I implement NTLM authentication?
+
+Microsoft is phasing out NTLM. For this reason, NTLM authentication won't be implemented in this library. However, it should be possible with the following curl options:
+
+- `CURLOPT_HTTPAUTH` as `CURLAUTH_NTLM`
+- `CURLOPT_USERPWD` with username and password, for example "username:password"
+
+Check [examples.md](examples.md) for an example.

examples.md

@@ -24,4 +24,21 @@ $request = $request->withHeader('X-MyHeader', 'Data');
 
 // Send the request to get the response. The response is a PSR-7 response.
 $response = $client->sendRequest($request);
-```
+```
+
+## NTLM authentication
+
+```php
+<?php
+
+declare(strict_types=1);
+
+use SharkMachine\Psr18Shark\Client;
+
+$factory = new Psr17Factory();
+$ntlmAuth = [
+    CURLOPT_HTTPAUTH => CURLAUTH_NTLM,
+    CURLOPT_USERPWD  => 'username:password',
+];
+$client = new Client($factory, $factory, curlOptions: $ntlmAuth);
+```