From 2fbd77af15dd3ad29a317e07fe3994121e004bdc Mon Sep 17 00:00:00 2001
From: Yunseo Hwang <yunseo.dev@gmail.com>
Date: Fri, 19 Jan 2024 23:03:37 +0900
Subject: [PATCH 1/2] docs: add configuration section to README.ko

---
 README.ko.md | 42 ++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 42 insertions(+)

diff --git a/README.ko.md b/README.ko.md
index 709de42..799c328 100644
--- a/README.ko.md
+++ b/README.ko.md
@@ -140,6 +140,48 @@ export class UserModule {}
 -   `POST /users/search` - retrieves a list of users based on complex search criteria
 -   `POST /users/:id/recover` - recovers a soft deleted user by ID
 
+## 구성
+
+Crud 데코레이터는 아래와 같은 구성 옵션을 제공합니다:
+
+### 엔티티
+
+(필수) 컨트롤러가 동작하기 위해서 TypeORM 엔티티가 필요합니다.
+
+### routes 옵션
+
+(선택) routes 옵션을 사용해서 각 Route에 대한 구성을 지정할 수 있습니다. 모든 Route에는 다음의 기본 옵션들이 있습니다.
+
+```typescript
+import { NestInterceptor, Type } from '@nestjs/common';
+
+interface RouteBaseOption {
+    decorators?: Array<PropertyDecorator | MethodDecorator>;
+    interceptors?: Array<Type<NestInterceptor>>;
+    swagger?: {
+        hide?: boolean;
+        response?: Type<unknown>;
+    };
+    exclude?: string[];
+}
+```
+
+그리고 각 Route들은 아래와 같은 고유한 옵션을 지닙니다.
+
+(추가 예정)
+
+### only 옵션
+
+(선택) 생성할 Route에 대한 배열을 지정하여 해당 Route들만 생성되도록 구성할 수 있습니다. 만약 지정되지 않는다면 모든 Route가 생성됩니다.
+
+예를 들어, CREATE/READ_ONE에 대해서만 생성하고 싶다면 아래와 같이 구성할 수 있습니다.
+
+```typescript
+import { Crud, Method } from '@nestjs-library/crud';
+
+@Crud({ entity: User, only: [Method.CREATE,  Method.READ_ONE] })
+```
+
 ---
 
 ## [Contributors](https://github.com/type-challenges/type-challenges/graphs/contributors)

From ed97fdeda1fdb05cba17d7e1bafbb198883aba65 Mon Sep 17 00:00:00 2001
From: Yunseo Hwang <yunseo.dev@gmail.com>
Date: Fri, 19 Jan 2024 23:12:13 +0900
Subject: [PATCH 2/2] =?UTF-8?q?docs:=20remove=20'=EC=98=B5=EC=85=98'=20&?=
 =?UTF-8?q?=20'=EC=97=94=ED=8B=B0=ED=8B=B0'=20->=20'entity'?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.ko.md | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/README.ko.md b/README.ko.md
index 799c328..fe76414 100644
--- a/README.ko.md
+++ b/README.ko.md
@@ -144,11 +144,11 @@ export class UserModule {}
 
 Crud 데코레이터는 아래와 같은 구성 옵션을 제공합니다:
 
-### 엔티티
+### entity
 
 (필수) 컨트롤러가 동작하기 위해서 TypeORM 엔티티가 필요합니다.
 
-### routes 옵션
+### routes
 
 (선택) routes 옵션을 사용해서 각 Route에 대한 구성을 지정할 수 있습니다. 모든 Route에는 다음의 기본 옵션들이 있습니다.
 
@@ -170,7 +170,7 @@ interface RouteBaseOption {
 
 (추가 예정)
 
-### only 옵션
+### only
 
 (선택) 생성할 Route에 대한 배열을 지정하여 해당 Route들만 생성되도록 구성할 수 있습니다. 만약 지정되지 않는다면 모든 Route가 생성됩니다.