Skip to content

Commit

Permalink
Merge pull request #4 from hexenq/dev
Browse files Browse the repository at this point in the history
migrate from node-gitlab to its successor gitbeaker
  • Loading branch information
hexenq committed Jul 29, 2020
2 parents 8738fdb + 17dcc02 commit 8e12321
Show file tree
Hide file tree
Showing 5 changed files with 437 additions and 221 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
</p>

<p align="center">
A <a href="https://github.com/jdalrymple/node-gitlab">node-gitlab</a> wrapper for <a href="https://github.com/nestjs/nest">NestJS</a> framework.
A <a href="https://github.com/jdalrymple/gitbeaker">gitbeaker</a> wrapper for <a href="https://github.com/nestjs/nest">NestJS</a> framework.
</p>

<p align="center">
Expand All @@ -18,12 +18,12 @@ Gitlab API library module for <a href="https://github.com/nestjs/nest">Nest</a>.
## Installation

```bash
npm install --save nest-gitlab gitlab
npm install --save nest-gitlab @gitbeaker/node
```

## Quick Start

Import `GitlabModule` and configure it with the same initiating options as the node-gitlab package.
Import `GitlabModule` and configure it with the same initiating options as the gitbeaker package.

```ts
import { GitlabModule } from 'nest-gitlab';
Expand Down Expand Up @@ -90,7 +90,7 @@ export class AppModule {}
```

## Bundle Support
node-gitlab provides [bundle](https://github.com/jdalrymple/node-gitlab#bundle-imports) feature which is a export for importing and instantiating all related API's of a specific resource at once. In order to use this feature, you could use the `InjectBundleRef` decorator combined with `forFeature` method:
gitbeaker provides [bundle](https://github.com/jdalrymple/gitbeaker#bundle-imports) feature which is a export for importing and instantiating all related API's of a specific resource at once. In order to use this feature, you could use the `InjectBundleRef` decorator combined with `forFeature` method:

```ts
import { GitlabModule } from 'nest-gitlab';
Expand Down
Loading

0 comments on commit 8e12321

Please sign in to comment.