From 523966c2121356110f079b6f791a7626277e651c Mon Sep 17 00:00:00 2001
From: Riccardo Senica <riccardo@frompixels.com>
Date: Sat, 16 Nov 2024 14:39:46 +0100
Subject: [PATCH] Updated readme

---
 README.md | 23 ++++++++++++++++++++++-
 1 file changed, 22 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index daf6988..bd8c349 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,22 @@
-# markdown2png
\ No newline at end of file
+# markdown2png
+
+A simple TypeScript tool that converts Markdown files to PNG images using Puppeteer.
+
+## Requirements
+
+- Node
+- yarn
+
+## Installation
+
+```bash
+yarn
+```
+
+## Commands
+
+```bash
+yarn dev PATH_TO_FILE.md
+```
+
+The output PNG file is in the `output` folder.