Skip to content

Commit 72f4a38

Browse files
committed
docs: add description of example
1 parent a50ff4a commit 72f4a38

File tree

2 files changed

+16
-0
lines changed

2 files changed

+16
-0
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -172,6 +172,11 @@ Here is the list of options:
172172

173173
`@ResponseBody()` will be added whenever `nest start` or `nest build` is executed.
174174

175+
## Example
176+
177+
There are some examples in the [example](./example) directory.
178+
Please refer to the [README.md](./example/README.md).
179+
175180
## License
176181

177182
This library is licensed under the MIT license.

example/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,14 @@
11
# Example
22

33
This is an example Nest.js project for this library.
4+
5+
## Description
6+
7+
This server contains two modules:
8+
9+
- [server](./src/server): contains REST API for serving content.
10+
- [client](./src/client): contains REST API for calling the server API.
11+
12+
`client` is calling `server` by using our HTTP interface library.
13+
14+
You can find HTTP interface files whose name ends with `.http.service.ts` in [client](./src/client) module.

0 commit comments

Comments
 (0)