From d824bcd22dae0f149a019180ea0010e2ae49a3a4 Mon Sep 17 00:00:00 2001 From: Jack Greenlee Date: Wed, 8 Nov 2023 23:57:11 -0500 Subject: [PATCH 1/2] Update README.md Remove note about node-gyp issues during installation. Since libxslt is now an optional peer dependency, it will not be installed along with enketo-transformer, so this note is irrelevant. In 'Prerequisites', we tell people to install libxslt separately (if necessary) and we do inform them of the requirements there. --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index b3a7193..d5ece53 100644 --- a/README.md +++ b/README.md @@ -63,8 +63,6 @@ Install Enketo Transformer with: npm install enketo-transformer ``` -*If you face issues during installation:* Verify that [these requirements](https://github.com/nodejs/node-gyp#on-unix) are met. We depend on upstream XSLT and XML C++ libraries that require compilation upon installation using [node-gyp](https://github.com/nodejs/node-gyp). - ### Node ```ts From cb2b219554de1b8a74b040f29a4e30b5e37d31fb Mon Sep 17 00:00:00 2001 From: Jack Greenlee Date: Thu, 9 Nov 2023 00:08:02 -0500 Subject: [PATCH 2/2] Update README.md Add note that may help people experiencing https://github.com/enketo/enketo-transformer/issues/185 --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index d5ece53..6694018 100644 --- a/README.md +++ b/README.md @@ -110,6 +110,8 @@ const result = await transform({ **Note:** because `preprocess` depends on `libxmljs` which is only available for Node, `preprocess` is also not supported on the web. If you must preprocess an XForm before it is transformed, you may do that before calling `transform`. +If your project uses Webpack or another bundler, you may need to [tell it to ignore the `libxslt` package](https://github.com/enketo/enketo-transformer/issues/185#issuecomment-1802426670). + ## Development/local usage ### Install