v1.0.1: update docs
This commit is contained in:
parent
96fcbdbcad
commit
cfe719bf2c
21
README.md
21
README.md
|
@ -2,6 +2,8 @@
|
|||
|
||||
Lightweight, Zero-dependency, translation between Unicode Strings, Binary Strings, Buffers, Base64, Hex, UCS-2, UTF-8, etc.
|
||||
|
||||
| < 1k gzipped | 2.6k minified | 3.6k full |
|
||||
|
||||
Works identically on all platforms:
|
||||
|
||||
- [x] Web Browsers
|
||||
|
@ -10,9 +12,28 @@ Works identically on all platforms:
|
|||
- Microsoft Edge
|
||||
- Internet Explorer
|
||||
- [x] Node.js
|
||||
- [x] WebPack
|
||||
|
||||
# Usage
|
||||
|
||||
**Vanilla JS**
|
||||
|
||||
```html
|
||||
<script src="https://unpkg.com/@root/encoding@1.0.0/dist/encoding.all.js"></script>
|
||||
```
|
||||
|
||||
```html
|
||||
<script src="https://unpkg.com/@root/encoding@1.0.0/dist/encoding.all.min.js"></script>
|
||||
```
|
||||
|
||||
```js
|
||||
var Enc = window.Encoding;
|
||||
|
||||
Enc.strToBuf('Hello, 世界!');
|
||||
```
|
||||
|
||||
**WebPack**, Node
|
||||
|
||||
```js
|
||||
var Enc = require('@root/encoding');
|
||||
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
{
|
||||
"name": "@root/encoding",
|
||||
"version": "1.0.0",
|
||||
"version": "1.0.1",
|
||||
"description": "Leightweight, Zero-dependency, translation between Unicode, Buffers, Base64, Hex, Binary Strings, UCS-2, UTF-8, etc.",
|
||||
"main": "./encoding.js",
|
||||
"browser": {
|
||||
|
|
Loading…
Reference in New Issue