Skip to content

Commit

Permalink
doc(README): Updates testing and building info
Browse files Browse the repository at this point in the history
  • Loading branch information
lupomontero committed Nov 20, 2024
1 parent b4b582b commit db23fa7
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -215,33 +215,33 @@ psl.isValid('www.google.com'); // true
psl.isValid('x.yz'); // false
```


## Testing and Building

Test are written using [`mocha`](https://mochajs.org/) and can be
run in two different environments: `node` and `phantomjs`.
There are tests both for Node.js and the browser (using [Playwright](https://playwright.dev)
and [BrowserStack](https://www.browserstack.com/)).

```sh
# Run tests in node.
npm test
# Run tests in browserstack.
npm run test:browserstack

# Build data (parse raw list) and create dist files
# Update rules from publicsuffix.org
npm run update-rules

# Build ESM, CJS and UMD and create dist files
npm run build
```

Feel free to fork if you see possible improvements!


## Acknowledgements

* Mozilla Foundation's [Public Suffix List](https://publicsuffix.org/)
* Thanks to Rob Stradling of [Comodo](https://www.comodo.com/) for providing
test data.
* Inspired by [weppos/publicsuffix-ruby](https://github.com/weppos/publicsuffix-ruby)


## License

The MIT License (MIT)
Expand Down

0 comments on commit db23fa7

Please sign in to comment.