Skip to content

Commit af93879

Browse files
committed
chore: fix readme formatting
1 parent b167ca1 commit af93879

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

readme.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ const successes = await ley.up({ ... });
152152
153153
> **TL;DR:** The contents of a `ley.config.js` file (default file name) is irrelevant to `ley` itself!
154154
155-
A config file is entirely optional since `ley` assumes that you're providing the correct environment variable(s) for your client driver. However, that may not always be possible. In those instances, a `ley.config.js` file (default file name) can be used to adjust your [driver](#drivers)'s `connect` method.
155+
A config file is entirely optional since `ley` assumes that you're providing the correct environment variable(s) for your client driver. However, that may not always be possible. In those instances, a `ley.config.js` file (default file name) can be used to adjust your [driver](#drivers)'s `connect` method – the file contents are passed directly to this function.
156156
157157
## Drivers
158158
@@ -261,10 +261,12 @@ Default: `migrations`
261261
The directory (relative to `opts.cwd`) to find migration files.
262262

263263
#### opts.driver
264-
Type: `string` or `Driver`
264+
Type: `string` or `Driver`<br>
265265
Default: `undefined`
266266

267-
When defined and a `string`, this is the **name** of your [driver](#drivers) implementation. It will pass through `require()` as written. Otherwise it's expected to match a [`Driver` interface](/ley.d.ts#L45-L67) and will be validated immediately.
267+
When defined and a `string`, this can be (a) the **name** of an internal driver, (b) the **name** of a third-party [driver](#drivers) module, or (c) a **filepath** to a local [driver](#drivers) implementation. It will pass through `require()` as written.
268+
269+
When defined an _not_ a `string`, it's expected to match the [`Driver` interface](/ley.d.ts#L45-L67) and will be validated immediately.
268270
269271
When undefined, `ley` searches for all supported client drivers in this order:
270272

0 commit comments

Comments
 (0)