Skip to content

Commit b662f8e

Browse files
committed
#7 update readme
1 parent a801a96 commit b662f8e

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

README.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,29 @@
11
# express-pdf-generator
2+
23
Using typescript and puppeteer, a pdf file generator with options to add header footer and watermark in every page.
34

45
# env variables
6+
57
APP_URL=Base url to the file paths
68

79
# request url
10+
811
http://127.0.0.1:5000/generate-pdf
912

1013
# request method
14+
1115
POST
1216

1317
# request paramaters
18+
1419
absoute path to the header image file with respect to base url. for example, for a url https://picsum.photos/800/300, APP_URL in env file should be 'https://picsum.photos' and the header will be '/800/300'
1520

1621
```javascript
1722
type RequestParams = {
18-
header?: string; // absout path to the header image.
19-
body?: string; // html content of the pdf body
20-
footer?: string; // absout path to the footer image.
21-
watermark?: string; // absout path to the watermark image.
23+
header?: string, // absoute path to the header image.
24+
body?: string, // html content of the pdf body
25+
footer?: string, // absoute path to the footer image.
26+
watermark?: string, // absoute path to the watermark image.
27+
original_cv?: string, // absoute path to the watermark image.
2228
};
29+
```

0 commit comments

Comments
 (0)