Skip to content

Commit 95317bc

Browse files
committed
chore: update git example
1 parent c63f81f commit 95317bc

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ Finds and reads closest `.git/config` file into a JS object.
142142
```js
143143
import { resolveGitConfig } from "pkg-types";
144144

145-
const gitConfig = await readGitConfig(".")
145+
const gitConfigObj = await readGitConfig(".")
146146
```
147147

148148
### `writeGitConfig`
@@ -152,7 +152,7 @@ Stringifies git config object into INI text format and writes it to a file.
152152
```js
153153
import { writeGitConfig } from "pkg-types";
154154

155-
const gitConfig = await writeGitConfig(".git/config", gitConfig)
155+
await writeGitConfig(".git/config", gitConfigObj)
156156
```
157157

158158
### `parseGitConfig`
@@ -162,7 +162,7 @@ Parses a git config file in INI text format into a JavaScript object.
162162
```js
163163
import { parseGitConfig } from "pkg-types";
164164

165-
const gitConfig = parseGitConfig(".")
165+
const gitConfigObj = parseGitConfig(gitConfigINI)
166166
```
167167

168168
### `stringifyGitConfig`
@@ -172,7 +172,7 @@ Stringifies a git config object into a git config file INI text format.
172172
```js
173173
import { parseGitConfig } from "pkg-types";
174174

175-
const stringifyGitConfig = stringifyGitConfig(".")
175+
const gitConfigINI = stringifyGitConfig(gitConfigObj)
176176
```
177177

178178
## Types

0 commit comments

Comments
 (0)