Skip to content

Commit

Permalink
Add table of contents
Browse files Browse the repository at this point in the history
  • Loading branch information
nflaig committed Sep 21, 2020
1 parent 1d251e8 commit dbdc892
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
<!-- omit in toc -->
# loopback4-migration

[![Actions Status][build-badge]][actions]
Expand All @@ -16,6 +17,18 @@ It provides a common interface to implement custom migration scripts and automat
the versioning of the database and the execution of the scripts based on the application version
compared to the database version.

<!-- omit in toc -->
## Contents

- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Usage](#usage)
- [Example](#example)
- [Configuration](#configuration)
- [Related resources](#related-resources)
- [Contributing](#contributing)
- [License](#license)

## Prerequisites

Some dependencies need to be installed as peer dependencies
Expand All @@ -41,6 +54,7 @@ of [manual configuration](#configuration).
npm install loopback4-migration
```

<!-- omit in toc -->
### Bind the component in `application.ts`

This will add the required model, repository and further artifacts to the application. By default,
Expand Down Expand Up @@ -150,6 +164,7 @@ export class MigrationScript101 implements MigrationScript {

The component can be configured in `application.ts` to overwrite the default values.

<!-- omit in toc -->
### Update default values

- `appVersion` - The application version retrieved from `package.json` can either be overwritten with
Expand Down Expand Up @@ -188,6 +203,7 @@ export class MyApplication extends BootMixin(
}
```

<!-- omit in toc -->
### Update directory and naming convention

It is also possible to update the default directory and file extension by changing the `bootOptions`
Expand Down

0 comments on commit dbdc892

Please sign in to comment.