docs: add proxy option to README

iwatakeshi · iwatakeshi · commit 9f51c85161df · 2025-11-30T14:11:55.000-08:00
diff --git a/README.md b/README.md
@@ -89,6 +89,11 @@ interface GitlyOptions {
    * Set the request headers (default: undefined)
    */
   headers?: RawAxiosRequestHeaders | AxiosHeaders
+  /**
+   * Sets the hostname, port, and protocol of the proxy server (default: undefined)
+   * Falls back to the https_proxy or http_proxy environment variables if not specified
+   */
+  proxy?: AxiosProxyConfig
   /**
    * Set the backend (default: undefined)
    *
