From 72f4a38a7255b488fcf91b4a6e573a8493401915 Mon Sep 17 00:00:00 2001
From: Jake Son <sonjeabin@gmail.com>
Date: Sun, 22 Oct 2023 11:46:05 +0900
Subject: [PATCH] docs: add description of example

---
 README.md         |  5 +++++
 example/README.md | 11 +++++++++++
 2 files changed, 16 insertions(+)

diff --git a/README.md b/README.md
index 553cd48..d2d909c 100644
--- a/README.md
+++ b/README.md
@@ -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.
diff --git a/example/README.md b/example/README.md
index d8e5d5d..245c1c5 100644
--- a/example/README.md
+++ b/example/README.md
@@ -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.