Skip to content

Commit

Permalink
doc: Update feature list
Browse files Browse the repository at this point in the history
  • Loading branch information
franky47 committed Jan 22, 2022
1 parent 284f658 commit 9abf8e8
Showing 1 changed file with 17 additions and 9 deletions.
26 changes: 17 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,18 @@
# `@47ng/codec`
<h1 align="center"><code>@47ng/codec</code></h1>

<div align="center">

[![NPM](https://img.shields.io/npm/v/@47ng/codec?color=red)](https://www.npmjs.com/package/@47ng/codec)
[![MIT License](https://img.shields.io/github/license/47ng/codec.svg?color=blue)](https://github.com/47ng/codec/blob/master/LICENSE)
![GitHub Workflow Status (branch)](https://img.shields.io/github/workflow/status/47ng/codec/Continuous%20Integration/next?label=CI)
[![Coverage Status](https://coveralls.io/repos/github/47ng/codec/badge.svg?branch=next)](https://coveralls.io/github/47ng/codec?branch=next)
![NPM Downloads](https://img.shields.io/npm/dm/@47ng/codec)

Universal conversion of Uint8Array from/into UTF-8, base64url and hex in the browser and Node.js

## Installation
</div>

```shell
$ yarn add @47ng/codec
# or
$ npm i @47ng/codec
```
<p align="center">
Universal conversion of Uint8Array from/into UTF-8, base64url and hex in the browser and Node.js
</p>

## Features

Expand All @@ -23,11 +21,21 @@ Available codecs:
- `utf8` - UTF-8
- `b64` - Base 64 URL ([RFC-4648, Section 5](https://tools.ietf.org/html/rfc4648#section-5))
- `hex` - Hexadecimal, lowercase
- Simple conversion between string representation
- Encoding detection

> Watch out !
> `utf8` uses a different convention than the other codecs (encode and decode
> are swapped), to reflect how `TextEncoder` and `TextDecoder` behave.
## Installation

```shell
$ yarn add @47ng/codec
# or
$ npm i @47ng/codec
```

## Support

- Node.js: >=11.x
Expand Down

0 comments on commit 9abf8e8

Please sign in to comment.