Skip to content

Commit 2e493a8

Browse files
committed
docs(readme): Adds docs for creating the repo facades.
1 parent bedc4b7 commit 2e493a8

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

readme.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,15 @@
33
44
### Usage
55
1. Install it with `npm i @js-migrations/core`.
6+
1. [Create a repository facade](#create-a-repository-facade)
67
1. [Use the factory to create the service facade](#use-the-factory).
78

9+
### Create a repository facade
10+
This package contains the [RepoFacade TypeScript interface](./src/RepoFacade.ts). You can create a facade to match the interface using the factories below.
11+
12+
- [Knex](https://github.com/js-migrations/knex)
13+
- [Mongo](https://github.com/js-migrations/mongo) - Coming Soon.
14+
815
### Use the factory
916
```typescript
1017
import migrationsServiceFactory from '@js-migrations/core/dist/factory';

0 commit comments

Comments
 (0)