doc: note full deprecation

mojito317 commented 2 years ago

Checklist

[x] Tick to sign-off your agreement to the Developer Certificate of Origin (DCO) 1.1
[x] Added tests for code changes or test/build only changes
[x] Updated the change log file (CHANGES.md|CHANGELOG.md) or test/build only changes
[x] Completed the PR template below:

Description

Add deprecation notice

Approach

Update notice to README, CHANGES. Intent is to also issue npm deprecate command with an updated message after this has merged to ensure deprecation warnings for library consumers.

Schema & API Changes

Deprecation notice, library EOL.

Security and Privacy

"No change"

Testing

N/A documentation

Monitoring and Logging

Warnings will be emitted on installation of the library after npm deprecate

mojito317 commented 2 years ago

Thanks for the reviews! I applied the changes from the swift lib in 997aa9f. Can you check this once again @emlaver, @eiri?

eiri commented 2 years ago

big yellow icons are fine with me as long as they are not blinking 😉

update, do we already have a replacement note somewhere, pointing to a new lib? the same was added to java and python, but not here.

mojito317 commented 2 years ago

update, do we already have a replacement note somewhere, pointing to a new lib? the same was added to java and python, but not here.

I am going to update the deprecation message executing the npm deprecate .. command as I will merge this PR. The current one is This package will be end-of-life on Dec 31 2021, please migrate to @ibm-cloud/cloudant. see the red block on the top of the npjms site.

cloudant / nodejs-cloudant