Skip to content

Commit 97ad13b

Browse files
committed
v1.0.0
1 parent 48b5ba2 commit 97ad13b

File tree

3 files changed

+17
-16
lines changed

3 files changed

+17
-16
lines changed

CHANGELOG.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
This project adheres to the
44
[Semantic Versioning 2.0 Specification](https://semver.org).
55

6-
## Unreleased
6+
## 1.0.0 - September 16, 2025
77

88
### ⚠️ Breaking
99

@@ -14,7 +14,8 @@ This project adheres to the
1414
- Searching the user's home directory for the default config file is no longer
1515
supported.
1616
- JSON, JSONC, and JSON5 are no longer supported as data file formats.
17-
- Supplying a custom template renderer is no longer supported.
17+
- Supplying a custom template renderer is no longer supported, as such,
18+
`templateOptions` is now `liquidOptions`.
1819

1920
### ✨ New
2021

@@ -23,8 +24,8 @@ This project adheres to the
2324
`pme.config.mjs`, and `pme.config.cjs` in the current working directory, in
2425
that order.
2526
- A helper for defining config objects, `defineConfig`, is now exported.
26-
- `launchOptions` for Puppeteer when it launches a browser instance can now be
27-
set in the config.
27+
- Launch options for Puppeteer when it launches a browser instance can now be
28+
set via the `launchOptions` config.
2829

2930
## 0.2.0 - February 01, 2023
3031

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -77,13 +77,13 @@ Examples:
7777
You may want to specify options to change the default behavior of the libraries
7878
that this CLI uses. For that, you can create a JavaScript config file that
7979
exports a config object at the current working directory where you will invoke
80-
`pme` or point to one using the `--config` flag. By default, `pme` will try to
81-
find `pme.config.js`, `pme.config.mjs`, and `pme.config.cjs` in the current
82-
working directory, in that order.
80+
`pme` or point to one using the `--config` or `-c` flag. By default, `pme` will
81+
try to find `pme.config.js`, `pme.config.mjs`, and `pme.config.cjs` in the
82+
current working directory, in that order.
8383

8484
Let's say you don't want the Chrome instance Puppeteer will use to be sandboxed,
8585
you want to be notified when you don't set variables in your YAML config file
86-
that your Liquid template expects, and you want your PDF to be landscape. You
86+
that your Liquid template expects, and you want your PDF to be in landscape. You
8787
can create a `pme.config.mjs` with the following contents:
8888

8989
```js
@@ -107,8 +107,8 @@ for what other options you can set:
107107

108108
**Note:** For `launchOptions`, `handleSIGHUP`, `handleSIGINT`, and
109109
`handleSIGTERM` are always set to `false` since `pme` handles those signals
110-
itself. When it comes to `pdfOptions`, `path` is always set to what is passed to
111-
the `--output` flag.
110+
itself. As for `pdfOptions`, `path` is always set to what is passed to the
111+
`--output` or `-o` flag.
112112

113113
## License
114114

package.json

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
{
22
"name": "pdf-made-easy",
3-
"version": "0.2.0",
3+
"version": "1.0.0",
44
"type": "module",
55
"license": "Apache-2.0",
66
"author": "Matthew Espino",
7-
"description": "A CLI application and library for developing and creating PDF documents.",
7+
"description": "A CLI application for building and developing PDF documents.",
88
"keywords": [
99
"cli",
1010
"yaml",
@@ -19,17 +19,17 @@
1919
"bugs": "https://github.com/mcecode/pdf-made-easy/issues",
2020
"repository": "mcecode/pdf-made-easy",
2121
"files": [
22-
"./*.js",
23-
"./*.d.ts",
22+
"./cli.js",
23+
"./index.js",
24+
"./lib.js",
2425
"./CHANGELOG.md"
2526
],
2627
"exports": "./index.js",
27-
"types": "./index.d.ts",
2828
"bin": {
2929
"pme": "./cli.js"
3030
},
3131
"engines": {
32-
"node": ">=16.19 <17 || >=18"
32+
"node": "^20 || ^22 || >=24"
3333
},
3434
"scripts": {
3535
"format": "prettier --write .",

0 commit comments

Comments
 (0)