Updated readme

2024-11-16 14:39:46 +01:00
parent c54eb91951
commit 523966c212
1 changed files with 22 additions and 1 deletions
--- a/README.md
+++ b/README.md
@@ -1 +1,22 @@
-# markdown2png
+# 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.