@stricahq/cbors/README.md

cbor encoder and decoder with annotation

<p align="center">
  <a href="https://strica.io/" target="_blank">
    <img src="https://docs.strica.io/images/logo.png" width="200">
  </a>
</p>

# @stricahq/cbors
CBOR ([RFC 7049](http://tools.ietf.org/html/rfc7049)) encoder and decoder for javascript data types with streaming support. cbors implements annotations for deriving sub-cbor buffer from original cbor buffer which is a requirement for working with Cardano data types.

## Installation

### yarn/npm

```sh
yarn add @stricahq/cbors
```

### Browser

```html
<script src="[use jsDelivr or Unpkg]"></script>

// access cbors global variable
```



## Usage

please see tests for usage examples and available data types

## API Doc
Find the API documentation [here](https://docs.strica.io/lib/cbors)

# License
Copyright 2022 Strica

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.