Skip to content

Commit

Permalink
Added the readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
Stephen Walters committed Oct 18, 2010
1 parent 76e5895 commit 25f6b86
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README
@@ -0,0 +1,16 @@
Node-Packer

Author: Stephen Walters <stephenwalters@gmail.com>

This is a binary data packer/unpacker for node.js. Supposedly, it is
functionally identical to python's struct.pack and struct.unpack, however,
it is nowhere near identical in practice.

Right now, the byte ordering support is not at all there. That is, the format
strings' first characters encoding directives (@, or =, or >, or <, or !) are
ignored completely. Also, only a few encoding types are supported, currently
just 'b', 'c', 'x', 'I', 'L', and 'B'.

I wrote this as a support structure for another project and just repackaged it
here, hence it's incompleteness. Being a strong YAGNI supporter, I didn't think
it was necessary to implement the features I wasn't going to use.

0 comments on commit 25f6b86

Please sign in to comment.