From 30523dff5bcd483b8fa778ae73caaa84057faad4 Mon Sep 17 00:00:00 2001
From: Steve King <steve@mydev.co>
Date: Fri, 19 Feb 2021 08:16:41 +0000
Subject: [PATCH] fix: Update documentation for configuring `SimpleGit` -
 `options` should be a `Partial<SimpleGitOptions>` to allow for supplying just
 some of its properties.

closes #580
---
 readme.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/readme.md b/readme.md
index 61bc2363..336f27e5 100644
--- a/readme.md
+++ b/readme.md
@@ -45,7 +45,7 @@ Configure each `simple-git` instance with a properties object passed to the main
 ```typescript
 import simpleGit, { SimpleGit, SimpleGitOptions } from 'simple-git';
 
-const options: SimpleGitOptions = {
+const options: Partial<SimpleGitOptions> = {
    baseDir: process.cwd(),
    binary: 'git',
    maxConcurrentProcesses: 6,