Skip to content

Commit

Permalink
Merge pull request #215 from hildjj/suggest-cbor2
Browse files Browse the repository at this point in the history
Make the move to cbor2 more explicit.
  • Loading branch information
hildjj authored Nov 6, 2024
2 parents 7c4e7a4 + 37d1f3b commit d62e2a7
Show file tree
Hide file tree
Showing 6 changed files with 66 additions and 1 deletion.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
13 changes: 12 additions & 1 deletion packages/cbor-bigdecimal/README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
12 changes: 12 additions & 0 deletions packages/cbor-cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
11 changes: 11 additions & 0 deletions packages/cbor-rn-prereqs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
11 changes: 11 additions & 0 deletions packages/cbor-web/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/).
Expand Down
10 changes: 10 additions & 0 deletions packages/cbor/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit d62e2a7

Please sign in to comment.