diff --git a/README.md b/README.md index c3e5d8f..4d0d033 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,16 @@ Encode and parse data in the Concise Binary Object Representation (CBOR) data format ([RFC8949](https://www.rfc-editor.org/rfc/rfc8949.html)). +## MOVE TO CBOR2 + +**NOTE** + +All new users and most existing users of these libraries should move to the +[cbor2](https://github.com/hildjj/cbor2) library. It is where most +maintenance and support and all new features are happening. + +*Only* catastrophic bugs will be fixed in these libraries going forward. + ## Pointers This is a monorepo that holds a few related packages: diff --git a/packages/cbor-bigdecimal/README.md b/packages/cbor-bigdecimal/README.md index 9cfc949..54a21c8 100644 --- a/packages/cbor-bigdecimal/README.md +++ b/packages/cbor-bigdecimal/README.md @@ -1,8 +1,19 @@ # cbor-bignumber -This package adds suppot for BigDecimal and BigFloats to the [cbor](../cbor) +This package adds support for BigDecimal and BigFloats to the [cbor](../cbor) package, relying on [bignumber.js](https://github.com/MikeMcl/bignumber.js). +## MOVE TO CBOR2 + +**NOTE** + +All new users and most existing users of this library should move to the +[cbor2](https://github.com/hildjj/cbor2) library. It is where most +maintenance and support and all new features are happening. cbor2 has +support for JavaScript bigints enabled by default. + +*Only* catastrophic bugs will be fixed in this library going forward. + ## Installation ```sh diff --git a/packages/cbor-cli/README.md b/packages/cbor-cli/README.md index dfee42a..b0e2e4b 100644 --- a/packages/cbor-cli/README.md +++ b/packages/cbor-cli/README.md @@ -4,6 +4,18 @@ A command-line interface for encoding and parse data in the Concise Binary Object Representation (CBOR) data format ([RFC8949](https://www.rfc-editor.org/rfc/rfc8949.html)). +## MOVE TO CBOR2 + +**NOTE** + +All new users and most existing users of this library should move to the +[cbor2](https://github.com/hildjj/cbor2) library. It is where most +maintenance and support and all new features are happening. The easiest way +to get this functionality on cbor2 is to use the web +[playground](https://hildjj.github.io/cbor2/playground/). + +*Only* catastrophic bugs will be fixed in this package going forward. + ## Supported Node.js versions This project now only supports versions of Node that the Node team is diff --git a/packages/cbor-rn-prereqs/README.md b/packages/cbor-rn-prereqs/README.md index fc70ac2..55c533e 100644 --- a/packages/cbor-rn-prereqs/README.md +++ b/packages/cbor-rn-prereqs/README.md @@ -2,6 +2,17 @@ Make it easier to use the cbor package in React Native. +## MOVE TO CBOR2 + +**NOTE** + +All users of this library should move to the +[cbor2](https://github.com/hildjj/cbor2) library. It is where most +maintenance and support and all new features are happening. This set of +workarounds has always been lightly-maintained, since React Native's JS +implementation is... not that similar to other modern runtimes. + +*Only* catastrophic bugs will be fixed in this library going forward. ## Installation: diff --git a/packages/cbor-web/README.md b/packages/cbor-web/README.md index ee0a25d..1ada277 100644 --- a/packages/cbor-web/README.md +++ b/packages/cbor-web/README.md @@ -7,6 +7,17 @@ This package bundles the [cbor](../cbor) package for easy use on the web. The f - [process](https://github.com/shtylman/node-process) - [stream-browserify](https://github.com/browserify/stream-browserify) +## MOVE TO CBOR2 + +**NOTE** + +ALL users of this library should move to the +[cbor2](https://github.com/hildjj/cbor2) library. It is where most +maintenance and support and all new features are happening. cbor2 works +natively on the web and does not this set of work-arounds and dependencies. + +*Only* catastrophic bugs will be fixed in this library going forward. + ## Examples You can see `cbor-web` in action on the web [here](https://hildjj.github.io/node-cbor/example/). diff --git a/packages/cbor/README.md b/packages/cbor/README.md index 456f246..29daa0f 100644 --- a/packages/cbor/README.md +++ b/packages/cbor/README.md @@ -2,6 +2,16 @@ Encode and parse data in the Concise Binary Object Representation (CBOR) data format ([RFC8949](https://www.rfc-editor.org/rfc/rfc8949.html)). +## MOVE TO CBOR2 + +**NOTE** + +All new users and most existing users of this library should move to the +[cbor2](https://github.com/hildjj/cbor2) library. It is where most +maintenance and support and all new features are happening. + +*Only* catastrophic bugs will be fixed in this library going forward. + ## Supported Node.js versions This project now only supports versions of Node that the Node team is