Updated readme
This commit is contained in:
21
README.md
21
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.
|
||||||
|
|||||||
Reference in New Issue
Block a user