Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sayan-rudder authored Mar 24, 2020
1 parent 0da7db7 commit 814fee7
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -166,5 +166,10 @@ You can start adding integrations of your choice for sending data through their

## How to build the SDK

1. Look for run scripts in the `package.json` file for getting browser minified and non-minified builds
2. For adding or removing integrations, modify the imports in `index.js` under integrations folder
- Look for run scripts in the `package.json` file for getting browser minified and non-minified builds. The builds are updated in the `dist` folder of the directory. Among the others, the important ones are:
- `npm run buildProdBrowser` : This outputs **rudder-analytics.min.js**.
- `npm run buildProdBrowserBrotli`: This outputs two files, **rudder-analytics.min.br.js** (the original minified file, same as above) and **rudder-analytics.min.br.js.br** (the brotli compressed file).
- `npm run buildProdBrowserGzip`: This outputs two files, **rudder-analytics.min.gzip.js** (the original minified file, same as above) and **rudder-analytics.min.gzip.js.gz** (the gzipped compressed file).
We are using **rollup** to build our SDKs, configuration for it is present in `rollup.config.js` in the repo directory.

- For adding or removing integrations, modify the imports in `index.js` under integrations folder.

0 comments on commit 814fee7

Please sign in to comment.