Skip to content

Commit

Permalink
docs: update
Browse files Browse the repository at this point in the history
  • Loading branch information
liaoliaots committed Feb 19, 2022
1 parent 3225e76 commit a9729d5
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 7 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,9 @@ Redis(<a href="https://github.com/luin/ioredis">ioredis</a>) module for NestJS f

- [Install](#install)
- [Redis](docs/latest/redis.md)
- [Non-global](docs/latest/redis.md#non-global)
- [Cluster](docs/latest/cluster.md)
- [Non-global](docs/latest/cluster.md#non-global)
- [Health Checks](docs/latest/health-checks.md)
- [Examples](docs/latest/examples.md)
- [Redis Sentinel](docs/latest/examples.md#sentinel)
Expand Down
6 changes: 4 additions & 2 deletions docs/latest/cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Usage

**Firstly**, we need to import the `ClusterModule` into our root module:
**1**, we need to import the `ClusterModule` into our root module:

```TypeScript
import { Module } from '@nestjs/common';
Expand All @@ -24,7 +24,7 @@ export class AppModule {}

> HINT: The `ClusterModule` is a [global module](https://docs.nestjs.com/modules#global-modules). Once defined, this module is available everywhere.
**Now**, we can use cluster in two ways.
**2**, we can use cluster in two ways.

via decorator:

Expand Down Expand Up @@ -320,3 +320,5 @@ import { ClusterModule } from '@liaoliaots/nestjs-redis';
})
export class AppModule {}
```

### Non-global
6 changes: 3 additions & 3 deletions docs/latest/health-checks.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@

## Usage

**Firstly**, we need to install the required package:
**1**, we need to install the required package:

```sh
$ npm install --save @nestjs/terminus
```

**Secondly**, we need to import the `TerminusModule` and `RedisHealthModule` into our business module:
**2**, we need to import the `TerminusModule` and `RedisHealthModule` into our business module:

```TypeScript
import { Module } from '@nestjs/common';
Expand Down Expand Up @@ -46,7 +46,7 @@ export class AppModule {}

> HINT: Both `TerminusModule` and `RedisHealthModule` aren't global modules.
**Now** let's create a health check:
**3**, let's create a health check:

```TypeScript
import { Controller, Get } from '@nestjs/common';
Expand Down
6 changes: 4 additions & 2 deletions docs/latest/redis.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Usage

**Firstly**, we need to import the `RedisModule` into our root module:
**1**, we need to import the `RedisModule` into our root module:

```TypeScript
import { Module } from '@nestjs/common';
Expand All @@ -25,7 +25,7 @@ export class AppModule {}

> HINT: The `RedisModule` is a [global module](https://docs.nestjs.com/modules#global-modules). Once defined, this module is available everywhere.
**Now**, we can use redis in two ways.
**2**, we can use redis in two ways.

via decorator:

Expand Down Expand Up @@ -431,3 +431,5 @@ import { RedisModule } from '@liaoliaots/nestjs-redis';
})
export class AppModule {}
```

### Non-global

0 comments on commit a9729d5

Please sign in to comment.