From 335a18507506715376ae78ae2c992d8dc2ec8ce3 Mon Sep 17 00:00:00 2001
From: wanhose <hello@wanhose.dev>
Date: Mon, 6 May 2024 20:07:42 +0200
Subject: [PATCH] docs(api): improve readme

---
 packages/api/docs/README.md | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)

diff --git a/packages/api/docs/README.md b/packages/api/docs/README.md
index 958c446..3559ffb 100644
--- a/packages/api/docs/README.md
+++ b/packages/api/docs/README.md
@@ -1,5 +1,31 @@
 # Cookie Monster Dialog API
 
+## Installation
+
+Make sure you have [Node.js](https://nodejs.org/) (version 20.x) and [Yarn](https://yarnpkg.com/) installed.
+
+```bash
+yarn install
+```
+
+## Scripts
+
+### `yarn build`
+
+Removes the build directory and compiles TypeScript files.
+
+### `yarn dev`
+
+Starts the server in development mode with nodemon.
+
+### `yarn lint`
+
+Lints the codebase using ESLint.
+
+### `yarn start`
+
+Starts the API server instance in production mode.
+
 ## Contributing
 
 Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.