Steps for releasing:

1. Review open issues and PRs to see if any can easily be fixed, closed, or merged.
2. Bump copyright year in README.md, if necessary.
3. Review CHANGELOG.md for completeness and correctness. Update its release date.
4. Create a release PR containing the updates relating to any of the steps above.
5. Ensure that the release PR is merged into main.
6. With main checked out, run yarn run release. This will generate the docs, deploy docs, tag the release, push it to origin, create a GitHub release, and version the package on NPM.
7. Verify the release on GitHub and NPM.
8. Manually edit the release on GitHub to include the release-specific notes found in CHANGELOG.md.

CHANGELOG

2.1.1 (2021-01-18)

• Upgrade yarn dependencies

2.1.0 (2021-01-05)

• The WebServiceClient class now accepts an options object as the third parameter. The currently valid options are timeout and host. To use the GeoLite2 web service instead of GeoIP2 Precision, set host to geolite.info. If you were previously passing the timeout as the third parameter, this is deprecated and you should transition to passing it in the options object.

2.0.0 (2020-11-02)

Breaking change

• country and city values return undefined instead of {} when empty.

1.6.0 (2020-09-29)

• Add the isResidentialProxy property to AnonymousIP and TraitsRecord for use with the Anonymous IP database and GeoIP2 Precision Insights.

1.5.0 (2020-08-07)

• Add connection-type to traits (Enterprise database)
• Add API ts-doc documentation

1.4.0 (2020-01-07)

• Drop support for Node 8.
• A network property has been added to the various response models. This represents the largest network where all the fields besides the IP address are the same.
• Add the userCount property to TraitsRecord. This is an integer which indicates the estimated number of users sharing the IP/network during the past 24 hours. This output is available from GeoIP2 Precision Insights.
• Add the staticIpScore property to TraitsRecord. This is a float which indicates how static or dynamic an IP address is. This output is available from GeoIP2 Precision Insights.

1.3.0 (2019-09-25)

• Upgrade yarn dependencies

1.2.0 (2020-09-19)

• Upgrade yarn dependencies

1.1.1 (2020-09-03)

• Fix path to types. GitHub #53.

1.1.0 (2020-09-03)

• Upgrade yarn dependencies

1.0.0 (2019-08-22)

• Fix user-agent header in request
• Point package.json's main to dist/src/index.js

0.6.0 (2019-06-04)

• Fix incorrect readerModel return type for country
• Update yarn.lock modules

0.5.0 (2019-04-15)

• Update yarn.lock modules

0.4.0 (2018-01-11)

• Drop support for Node 6.
• Fix export of models and record interfaces.

0.3.0 (2018-01-02)

• Add web service API support.

0.2.1 (2018-12-27)

• Fix Buffer documentation.

0.2.0 (2018-12-21)

• Add ability to use Buffers instead of local db file.

0.1.1 (2018-11-20)

• Fix release script.

0.1.0 (2018-11-16)

• Initial release.