From 8b64580745a1ad7d5a0043094b37d0ff7af9eb94 Mon Sep 17 00:00:00 2001
From: p-sw <shinwoo.park@psw.kr>
Date: Wed, 26 Mar 2025 22:47:08 +0000
Subject: [PATCH] Add Introduction

---
 Introduction.md | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)
 create mode 100644 Introduction.md

diff --git a/Introduction.md b/Introduction.md
new file mode 100644
index 0000000..966fc5a
--- /dev/null
+++ b/Introduction.md
@@ -0,0 +1,29 @@
+# NestLogged
+
+[NestLogged](https://www.npmjs.org/package/nestlogged) is a logging decorator set for [NestJS](https://nestjs.com). It provides simple way to remove logging from the function body in NestJS, so developer can focus on the "real" business code.
+
+You can get logs with just a few simple decorators attached to the class, function, parameter.
+
+Here is the key feature of NestLogged:
+
+* Initialize logger with simple decorator
+* Add scope to Logger
+* Print logs on function call and return with just a decorator
+* Log parameter values and return values as well
+* Track each request easily with unique request ID
+
+## Installation
+
+```sh
+$ npm install nestlogged
+```
+
+If you use Fastify:
+
+```sh
+$ npm install nestlogged-fastify
+```
+
+> We made completely separate fastify package because we had to overwrite some of the decorators to make sure unique request has single id between middleware decorator and other logging decorator.
+
+You can simply use `nestlogged-fastify` by replacing `nestlogged`.
\ No newline at end of file