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.