Skip to content

Commit

Permalink
docs: add description of example
Browse files Browse the repository at this point in the history
  • Loading branch information
jbl428 committed Oct 22, 2023
1 parent a50ff4a commit 72f4a38
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -172,6 +172,11 @@ Here is the list of options:

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

## Example

There are some examples in the [example](./example) directory.
Please refer to the [README.md](./example/README.md).

## License

This library is licensed under the MIT license.
Expand Down
11 changes: 11 additions & 0 deletions example/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,14 @@
# Example

This is an example Nest.js project for this library.

## Description

This server contains two modules:

- [server](./src/server): contains REST API for serving content.
- [client](./src/client): contains REST API for calling the server API.

`client` is calling `server` by using our HTTP interface library.

You can find HTTP interface files whose name ends with `.http.service.ts` in [client](./src/client) module.

0 comments on commit 72f4a38

Please sign in to comment.