diff --git a/README.md b/README.md index bead17409..a0eff9e37 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,17 @@ A curated list of known less-than-honest sites inclusive of a simple JS utility function to check any host against this list. -Any additions can be made by editing [all.json](https://github.com/polkadot-js/phishing/edit/master/all.json) and adding any new sites in alphabetical order. +## Additions -Making additions to the list will be reflected (on merge) at [polkadot.js.org/phishing/all.json](https://polkadot.js.org/phishing/all.json) and can be consumed via the [@polkadot/phishing library](https://github.com/polkadot-js/phishing/tree/master/packages/phishing) and other tools. +To add a new site, editing [all.json](https://github.com/polkadot-js/phishing/edit/master/all.json) and add any new sites. + +To add anew scam address (typically per site), edit [address.json](https://github.com/polkadot-js/phishing/edit/master/address.json) and add it in the correct section (which is keyed by the site providing them). + +## Availability + +Making additions to the list will be reflected on merge at [polkadot.js.org/phishing/all.json](https://polkadot.js.org/phishing/all.json) & [polkadot.js.org/phishing/address.json](https://polkadot.js.org/phishing/address.json). These can be consumed via the [@polkadot/phishing library](https://github.com/polkadot-js/phishing/tree/master/packages/phishing) and other tools. ## Contributing -This list is intended to be maintained with active input from the community, so contributions are welcome, either via a pull request or by [logging an issue](https://github.com/polkadot-js/phishing/issues). +This list is intended to be maintained with active input from the community, so contributions are welcome, either via a pull request (edit above as described in additions) or by [logging an issue](https://github.com/polkadot-js/phishing/issues).