nw-builder 4.0.4 → 4.0.6

package/.github/workflows/cd.yml

@@ -14,7 +14,6 @@ jobs:
           node-version: "18"
 
       - run: npm ci
-      - run: npm run cjs
       - uses: JS-DevTools/npm-publish@v1
         with:
           token: ${{ secrets.NPM_TOKEN }}

package/.github/workflows/ci.yml

@@ -24,5 +24,4 @@ jobs:
       - run: npm run format
       - run: npm run lint
       - run: npm run test:unit
-      - run: npm run cjs
       - run: npm run test:e2e

package/README.md

@@ -7,7 +7,14 @@ Build [NW.js](https://github.com/nwjs/nw.js) applications for Mac, Windows and L
 
 > Before using `nw-builder`, please go through how to [write an NW.js application](https://nwjs.readthedocs.io/en/latest/For%20Users/Getting%20Started/).
 
-## Install
+- [Installation](https://github.com/nwutils/nw-builder#installation)
+- [Usage](https://github.com/nwutils/nw-builder#usage)
+- [Limitations](https://github.com/nwutils/nw-builder#limitations)
+- [API Reference](https://nwutils.io/nw-builder/global#nwbuild)
+- [Contributing](https://github.com/nwutils/nw-builder#contributing)
+- [License](https://github.com/nwutils/nw-builder#license)
+
+## Installation
 
 Install `nw-builder` via `npm` or your preferred Node package manager of choice.
 
@@ -100,26 +107,11 @@ package.json usage
 }
 ```
 
-## API Reference
-
-### Methods
+For more options, check out the [API reference](https://nwutils.io/nw-builder/global#nwbuild).
 
-`nwbuild(options) :Promise<undefined>`
+## Limitations
 
-| Name        | Type                                | Default                    | Description                                                                    |
-| ----------- | ----------------------------------- | -------------------------- | ------------------------------------------------------------------------------ |
-| srcDir      | `string`                            | `./`                       | Directories which hold NW app code                                             |
-| mode        | `run \| build`                      | `build`                    | Run or build application                                                       |
-| version     | `latest \| stable \| string \| lts` | `latest`                   | NW runtime version                                                             |
-| flavor      | `sdk \| normal`                     | `normal`                   | NW runtime build flavor.                                                       |
-| platform    | `linux \| osx \| win`               | `<current platform>`       | NW supported platforms                                                         |
-| arch        | `ia32 \| x64`                       | `<current architecture>`   | NW supported architectures                                                     |
-| outDir      | `string`                            | `./out`                    | Directory to store build artifacts                                             |
-| cacheDir    | `string`                            | `./cacheDir`               | Directory to store NW binaries                                                 |
-| downloadUrl | `string`                            | `https://dl.nwjs.io`       | URI to download NW binaries from                                               |
-| manifestUrl | `string`                            | `https://nwjs.io/versions` | URI to download manifest from                                                  |
-| cache       | `boolean`                           | `true`                     | If `true` the existing cache is used. Otherwise it removes and redownloads it. |
-| zip         | `boolean`                           | `false`                    | If `true` the `outDir` directory is zipped                                     |
+- #716 File permissions are incorrectly set for Linux or MacOS apps built on Windows platform.
 
 ## Migration to v4
 
@@ -334,7 +326,7 @@ await nwbuild({
 1. Pick and install a Node version manager
    - Linux/OSX - [nvm](https://github.com/nvm-sh/nvm)
    - Win 7+/Linux/OSX - [volta](https://volta.sh)
-1. Use your version manager to install Node 14.19 or above
+1. Use your version manager to install Node 16.19 or above
 1. Run `npm install`
 1. `npm run demo` to test your changes at first glance
 1. `npm t` to run unit tests