Skip to content

Commit 41a2243

Browse files
committed
README
1 parent 333a0d7 commit 41a2243

File tree

1 file changed

+10
-31
lines changed

1 file changed

+10
-31
lines changed

README.md

Lines changed: 10 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
![ByteBuffer.js - A Java-like ByteBuffer](https://raw.github.com/dcodeIO/ByteBuffer.js/master/ByteBuffer.png)
22
======================================
3-
Provides a full-features ByteBuffer implementation using typed arrays. It also tries to abstract a bit of
4-
the complexity away by providing convenience methods for those who just want to write stuff without caring about signed,
5-
unsigned and the actual bit sizes. It's also one of the components driving [ProtoBuf.js](https://github.com/dcodeIO/ProtoBuf.js)
6-
and the [PSON](https://github.com/dcodeIO/PSON) reference implementation.
3+
Provides a full-features ByteBuffer implementation using typed arrays. It's one of the core components driving
4+
[ProtoBuf.js](https://github.com/dcodeIO/ProtoBuf.js) and the [PSON](https://github.com/dcodeIO/PSON) reference
5+
implementation.
76

87
*Note:* The API behind toHex and toString has changed with ByteBuffer 2.0.0, which is a generally revised release, in
98
favor of making this more intuitive.
@@ -19,7 +18,7 @@ What can it do?
1918
* Relative and absolute zero-copy operations
2019
* Automatic resizing (always doubles)
2120
* Chaining of all operations that do not return a specific value
22-
* Slicing, appending, prepending etc.
21+
* Slicing, appending, prepending, flip, reset, etc.
2322

2423
And much more... (see the API documentation)
2524

@@ -103,41 +102,21 @@ Downloads
103102

104103
Documentation
105104
-------------
106-
* [View documentation](http://htmlpreview.github.com/?http://github.com/dcodeIO/ByteBuffer.js/master/docs/ByteBuffer.html)
105+
* [View the API documentation](http://htmlpreview.github.com/?http://github.com/dcodeIO/ByteBuffer.js/master/docs/ByteBuffer.html)
107106

108107
Tests (& Examples) [![Build Status](https://travis-ci.org/dcodeIO/ByteBuffer.js.png?branch=master)](https://travis-ci.org/dcodeIO/ByteBuffer.js)
109108
------------------
110109
* [View source](https://github.com/dcodeIO/ByteBuffer.js/blob/master/tests/suite.js)
111110
* [View report](https://travis-ci.org/dcodeIO/ByteBuffer.js)
112111

113-
Prerequisites to run it against IE<10, FF<15, Chrome<9 etc.
114-
-----------------------------------------------------------
115-
* Working ArrayBuffer & DataView implementations (i.e. use a [polyfill](https://github.com/inexorabletash/polyfill#typed-arrays-polyfill))
116-
117-
Usage with Closure Compiler's advanced optimizations
118-
----------------------------------------------------
119-
You basically have the following three options:
120-
121-
#### ByteBuffer.js as external dependency ####
122-
If you compile your code but want to use ByteBuffer.js as an external dependency that's not actually compiled "into"
123-
your project, add the provided [externs file](https://github.com/dcodeIO/ByteBuffer.js/blob/master/externs/ByteBuffer.js)
124-
to your compilation step (which usually excludes compilation of ByteBuffer.js).
125-
126-
#### ByteBuffer.js compiled into your project and exposed ####
127-
Use [ByteBuffer.js](https://github.com/dcodeIO/ByteBuffer.js/blob/master/ByteBuffer.js) if you want the ByteBuffer class
128-
to be exposed to the outside world (of JavaScript) so it can be called by external scripts. This also removes the
129-
requirement of using externs but the compiler will also keep possibly unused code.
130-
131-
#### ByteBuffer.js fully compiled into your project ####
132-
Use [ByteBuffer.noexpose.js](https://github.com/dcodeIO/ByteBuffer.js/blob/master/ByteBuffer.noexpose.js) if you want
133-
the ByteBuffer class to be fully integrated into your (single file) project. Of course no external scripts will be able
134-
to call it or its method (trivially) because quite everything will become renamed, some parts inlined and moved around.
135-
This will also allow the compiler to actually remove unused code.
112+
Support for IE<10, FF<15, Chrome<9 etc.
113+
---------------------------------------
114+
* Requires a working ArrayBuffer & DataView implementations (i.e. use a [polyfill](https://github.com/inexorabletash/polyfill#typed-arrays-polyfill))
136115

137116
Contributors
138117
------------
139-
[Dretch](https://github.com/Dretch) (IE8 comp.)
118+
[Dretch](https://github.com/Dretch) (IE8 compatibility)
140119

141120
License
142121
-------
143-
Apache License, Version 2.0 - http://www.apache.org/licenses/LICENSE-2.0.html
122+
Apache License, Version 2.0 - http://www.apache.org/licenses/LICENSE-2.0.html

0 commit comments

Comments
 (0)