add readme

This commit is contained in:
Timo Hocker 2020-03-06 08:42:42 +01:00
parent 3bdcadd973
commit 64a7384d04

13
README.md Normal file
View File

@ -0,0 +1,13 @@
# Encoding Helper
Converting strings between different encodings
## Usage
```js
const encoding = require('@scode/encoding-helper');
const hex = encoding.to_hex('abc'); // convert any encoding to hex, default is utf-8
const b64 = encoding.to_b64(hex, 'hex'); // convert any encoding to base64, default is utf-8
const utf8 = encoding.to_utf8(hex, 'hex'); // convert any encoding to utf-8, no default
```