Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jim / Publisher documentation #6002

Merged
merged 10 commits into from
Aug 15, 2022
4 changes: 2 additions & 2 deletions packages/publisher/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ The executable script (exposed as `deriv-publisher`) takes a single argument (ei

The Webpack utilities help Webpack resolve imports to any local `@deriv` dependencies:

- `getLocalDerivPackageAliases`: returns an object of aliases when creating a build for publishing, i.e. it will tell Webpack to ignore the `node_modules` and tells it where to look instead.
- `getLocalDerivPackageAliases`: returns an object of aliases when creating a build for publishing, i.e. it will tell Webpack to ignore the `node_modules` and tells it where to look instead (in the local file path i.e. the absolute path of the executing file).
- `getLocalDerivPackageExternals`: returns an object of externals when creating a build that won't be published, i.e. it will tell Webpack to not bundle these packages as they will be included by the consumer of this package.

## Example
Expand All @@ -40,7 +40,7 @@ Below is a simple example that could easily be extended.
}
}
```

The `publish_package` command first removes local `@deriv` packages using prepublish, then it publishes the package to the npm registry and restores the local `@deriv` packages to package.json using postpublish
## Install

```
Expand Down