Update README

iwatakeshi · Feb 15, 2024 · bf26771 · bf26771
1 parent 1019729
commit bf26771
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -89,6 +89,17 @@ interface GitlyOptions {
    * Set the request headers (default: undefined)
    */
   headers?: RawAxiosRequestHeaders | AxiosHeaders
+  /**
+   * Set the backend (default: undefined)
+   *
+   * @example
+   * ```markdown
+   * 'axios' - default behavior
+   * 'git' - use local git installation to clone the repository (allows for cloning private
+   * repositories as long as the local git installation has access)
+   * ```
+   */
+  backend?: 'axios' | 'git'
 }
 ```