Skip to content

Commit 43dedf3

Browse files
committed
Cleanup
1 parent dc20222 commit 43dedf3

15 files changed

+131
-26661
lines changed

README.md

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,20 @@
1-
![ByteBuffer.js - A full-featured and highly optimized ByteBuffer in JavaScript](https://raw.github.com/dcodeIO/ByteBuffer.js/master/ByteBuffer.png)
1+
![ByteBuffer.js - The swiss army knife for binary data in JavaScript.](https://raw.github.com/dcodeIO/ByteBuffer.js/master/ByteBuffer.png)
22
======================================
3-
ByteBuffer.js provides a full-featured and highly optimized ByteBuffer implementation in JavaScript, since version 3
4-
either backed by an ArrayBuffer for browser environments (ByteBufferAB) or, alternatively, a node Buffer (ByteBufferNB)
5-
to make use of the performance benefits when running under node.js. Both versions are API-compatible and generated from
6-
a single source tree using [MetaScript](https://github.com/dcodeIO/MetaScript).
3+
A fast and complete ByteBuffer implementation using either ArrayBuffers in the browser or node Buffers under node.js,
4+
generated from a single source tree through [MetaScript](https://github.com/dcodeIO/MetaScript).
75

86
If you are looking for ByteBuffer.js 2, [that's the branch](https://github.com/dcodeIO/ByteBuffer.js/tree/ByteBuffer2).
97

10-
**Please note**: Though all old and new test cases are passing, ByteBuffer.js 3 still needs to be tested in real world
11-
scenarios. Also, the API has changed a bit to make things more straight forward.
12-
138
What can it do?
149
---------------
15-
* Mimics Java ByteBuffers as close as reasonable while using typed array terms
1610
* 8, 16, 32 and 64 bit signed and unsigned integers
1711
* 32 and 64 bit floats
1812
* Big and little endianness
19-
* Variable length integers as used in protobuf (32 and 64 bit, including zig zag encoding)
13+
* Varints as used in protobuf (32 and 64 bit, zig-zag)
2014
* Base64, binary, debug, hex and utf8 encodings
2115
* Handy string and debugging utilities
2216
* Relative and absolute zero-copy operations wherever possible
23-
* Manual and automatic resizing (efficiently doubles capacity)
17+
* Transparent resizing when using unknown-length data
2418
* Chaining of all operations that do not return a specific value
2519
* Slicing, appending, prepending, reversing, flip, mark, reset, etc.
2620

@@ -89,7 +83,7 @@ Downloads
8983

9084
Documentation
9185
-------------
92-
* [View the API documentation](http://htmlpreview.github.com/?http://github.com/dcodeIO/ByteBuffer.js/master/docs/ByteBuffer.html)
86+
* [View the API documentation](http://htmlpreview.github.com/?http://github.com/dcodeIO/ByteBuffer.js/master/docs/module-ByteBuffer.html)
9387

9488
Tests (& Examples) [![Build Status](https://travis-ci.org/dcodeIO/ByteBuffer.js.png?branch=master)](https://travis-ci.org/dcodeIO/ByteBuffer.js)
9589
------------------

0 commit comments

Comments
 (0)