Skip to content

Commit aa580e7

Browse files
committed
READMEs
1 parent 6f53590 commit aa580e7

File tree

2 files changed

+10
-12
lines changed

2 files changed

+10
-12
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ generated from a single source tree through [MetaScript](https://github.com/dcod
99
Features
1010
--------
1111
* Three API-compatible versions:
12-
* **ByteBufferNB** : Backing buffer / Accessor: node Buffer
13-
* **ByteBufferAB** : Backing buffer: ArrayBuffer, Accessor: DataView
14-
* **ByteBufferTA** : Backing buffer: ArrayBuffer, Accessor: Uint8Array
12+
* **ByteBufferNB**   Backing buffer / Accessor: node Buffer
13+
* **ByteBufferAB**   Backing buffer: ArrayBuffer, Accessor: Uint8Array
14+
* **ByteBufferAB_DataView**   Backing buffer: ArrayBuffer, Accessor: DataView
1515
* 8, 16, 32 and 64 bit signed and unsigned integers
1616
* 32 and 64 bit floats
1717
* Varints as used in protobuf (32 and 64 bit, zig-zag)

dist/README.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@ Distributions
33

44
ByteBuffer uses either ArrayBuffers in the browser or Buffers under node.js.
55

6-
### Browsers: ArrayBuffers
6+
### Browsers: [ArrayBuffer](https://developer.mozilla.org/de/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer)s
77

8-
##### Using Typed Arrays
8+
##### Using [TypedArray](https://developer.mozilla.org/de/docs/Web/JavaScript/Reference/Global_Objects/TypedArray)s
99

1010
* **[ByteBufferAB.js](https://raw.githubusercontent.com/dcodeIO/ByteBuffer.js/master/dist/ByteBufferAB.js)**
11-
uses an ArrayBuffer as its backing buffer, accessed through an Uint8Array (Typed Array).
11+
uses an ArrayBuffer as its backing buffer, accessed through an [Uint8Array](https://developer.mozilla.org/de/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array).
1212

1313
* **[ByteBufferAB.min.js](https://raw.githubusercontent.com/dcodeIO/ByteBuffer.js/master/dist/ByteBufferAB.min.js)**
1414
has been compiled with Closure Compiler using advanced optimizations.
@@ -19,10 +19,10 @@ ByteBuffer uses either ArrayBuffers in the browser or Buffers under node.js.
1919
* **[ByteBufferAB.min.map](https://raw.githubusercontent.com/dcodeIO/ByteBuffer.js/master/dist/ByteBufferAB.min.map)**
2020
is the source map generated by Closure Compiler.
2121

22-
##### Using a DataView
22+
##### Using [DataView](https://developer.mozilla.org/de/docs/Web/JavaScript/Reference/Global_Objects/DataView)s
2323

2424
* **[ByteBufferAB_DataView.js](https://raw.githubusercontent.com/dcodeIO/ByteBuffer.js/master/dist/ByteBufferAB_DataView.js)**
25-
uses an ArrayBuffer as its backing buffer, accessed through a DataView.
25+
uses an ArrayBuffer as its backing buffer, accessed through a [DataView](https://developer.mozilla.org/de/docs/Web/JavaScript/Reference/Global_Objects/DataView).
2626

2727
* **[ByteBufferAB_DataView.min.js](https://raw.githubusercontent.com/dcodeIO/ByteBuffer.js/master/dist/ByteBufferAB_DataView.min.js)**
2828
has been compiled with Closure Compiler using advanced optimizations.
@@ -33,15 +33,13 @@ ByteBuffer uses either ArrayBuffers in the browser or Buffers under node.js.
3333
* **[ByteBufferAB_DataView.min.map](https://raw.githubusercontent.com/dcodeIO/ByteBuffer.js/master/dist/ByteBufferAB_DataView.min.map)**
3434
is the source map generated by Closure Compiler.
3535

36-
### node.js: Buffers
36+
### node.js: [Buffer](https://nodejs.org/api/buffer.html)s
3737

3838
* **[ByteBufferNB.js](https://raw.githubusercontent.com/dcodeIO/ByteBuffer.js/master/dist/ByteBufferNB.js)**
39-
uses a node Buffer as its backing buffer.
39+
uses a [node Buffer](https://nodejs.org/api/buffer.html) as its backing buffer and accessor.
4040

4141
Also available as `bytebuffer` on [npm](https://www.npmjs.org/package/bytebuffer) and
4242
[bower](http://bower.io/search/?q=bytebuffer).
4343

4444
When installed as an [npm package](https://www.npmjs.org/package/bytebuffer), both versions are available.
4545
`exports` and `exports.ByteBufferNB` point at ByteBufferNB, `exports.ByteBufferAB` points at ByteBufferAB.
46-
47-
**See also:** [Experimental distributions](https://github.com/dcodeIO/ByteBuffer.js/tree/master/dist/experimental)

0 commit comments

Comments
 (0)