Skip to content

Commit 326690a

Browse files
committed
clearer example
1 parent 888e7f3 commit 326690a

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ It utilizes file-based routing, [zod](https://zod.dev/) input and output validat
1010

1111
## Features
1212

13-
- **Easy Setup:** Quick and simple installation process.
13+
- **No Setup Required** if the OpenAPI spec is not needed. Otherwise, just call `setupEndpoints` during app start-up.
1414
- **User-Friendly API:** Supports file-based routing and both basic and advanced per-endpoint configuration.
1515
- **Fully Typed:** Compile and run-time validation of input and output values using Zod schemas.
1616
- **HTTP Adapter agnostic:** Works with both Express and Fastify NestJS applications.
17-
- **Stable:** Fully-tested for \*nix systems and produces regular NestJS Controllers under the hood.
17+
- **Stable:** Produces regular **NestJS Controllers** under the hood.
1818

1919
## Getting Started
2020

@@ -66,7 +66,7 @@ export default endpoint({
6666
.object({
6767
id: z.number(),
6868
name: z.string(),
69-
email: z.string(),
69+
email: z.string().email(),
7070
})
7171
.nullable(),
7272
inject: {
@@ -106,10 +106,11 @@ export default endpoint({
106106
import { EndpointsModule } from 'nestjs-endpoints';
107107
import create from './create.endpoint';
108108
import find from './find.endpoint';
109+
// ...
109110

110111
@EndpointsModule({
111112
endpoints: [create, find],
112-
// ...
113+
providers: [DbService],
113114
})
114115
export class UserModule {}
115116
```

0 commit comments

Comments
 (0)