Skip to content

Commit

Permalink
chore: fix readme formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
lukeed committed Sep 24, 2020
1 parent b167ca1 commit af93879
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ const successes = await ley.up({ ... });
> **TL;DR:** The contents of a `ley.config.js` file (default file name) is irrelevant to `ley` itself!
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.
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.
## Drivers
Expand Down Expand Up @@ -261,10 +261,12 @@ Default: `migrations`
The directory (relative to `opts.cwd`) to find migration files.

#### opts.driver
Type: `string` or `Driver`
Type: `string` or `Driver`<br>
Default: `undefined`

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.
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.

When defined an _not_ a `string`, it's expected to match the [`Driver` interface](/ley.d.ts#L45-L67) and will be validated immediately.
When undefined, `ley` searches for all supported client drivers in this order:
Expand Down

0 comments on commit af93879

Please sign in to comment.