Skip to content

Commit 10afb7c

Browse files
committed
chore: update readme
1 parent b538f66 commit 10afb7c

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

packages/mongodb-downloader/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22

33
A simple library to download MongoDB binaries for different platforms and versions.
44

5-
### Migrating from v0.4 to v0.5
5+
### Migrating from v0.5 to v0.6+
66

7-
In v0.5.x, the library introduced lockfiles to prevent parallel downloads of the same MongoDB binary. It also changed the arguments for the `downloadMongoDb` and `downloadMongoDbWithVersionInfo` functions, introducing a new `useLockfile` field and using a single options object instead of separate parameters for different options. It is recommended to enable lockfiles to prevent redundant downloads unless you have a specific reason not to.
7+
In v0.6.x, the library introduced lockfiles to prevent parallel downloads of the same MongoDB binary. It also changed the arguments for the `downloadMongoDb` and `downloadMongoDbWithVersionInfo` functions, introducing a new `useLockfile` field and using a single options object instead of separate parameters for different options. It is recommended to enable lockfiles to prevent redundant downloads unless you have a specific reason not to.
88

99
```ts
10-
// Before (v0.4.x)
10+
// Before (v0.5.x)
1111
downloadMongoDb('/tmp/directory', '4.4.6', {
1212
platform: 'linux',
1313
arch: 'x64',
@@ -17,7 +17,7 @@ downloadMongoDbWithVersionInfo('/tmp/directory', '4.4.6', {
1717
arch: 'x64',
1818
});
1919

20-
// After (v0.5.x)
20+
// After (v0.6.x)
2121
downloadMongoDb({
2222
directory: '/tmp/directory',
2323
version: '4.4.6',

0 commit comments

Comments
 (0)