Merge 83eac2e into 230f704

castle · Nov 11, 2020 · 753e201 · 753e201
2 parents 230f704 + 83eac2e
commit 753e201
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -28,6 +28,24 @@ Configure the library with your Castle API secret.
 Castle::setApiKey('YOUR_API_SECRET');
 ```
 
+## Optional Configurations
+
+Set preferred connection and request timeouts:
+valid options for setting are:
+- `CURLOPT_CONNECTTIMEOUT`
+- `CURLOPT_CONNETTIMEOUT_MS`
+- `CURLOPT_TIMEOUT`
+- `CURLOPT_TIMEOUT_MS`
+
+```php
+Castle::setCurlOpts($curlOpts)
+```
+
+Set a specified list of request headers to include with event context (optional, not recommended):
+```php
+Castle::setUseWhitelist($headers)
+```
+
 ## Request context
 
 By default, Castle extracts all the necessary information, such as IP and request