Filled out README/DESCRIPTION

pao · Dec 14, 2012 · e22429d · e22429d
1 parent 0ea886d
commit e22429d
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -0,0 +1 @@
+Swiss Army Knife for encoding and decoding structured binary streams.
diff --git a/README.md b/README.md
@@ -0,0 +1,8 @@
+StrPack: Structured Binary Stream Tools
+=======================================
+
+One of the things I find annoying about MATLAB is dealing with binary data. There's a lot of boilerplate, a lot of `fread()`, and some weird thing involving a `=>`.
+
+Enter StrPack. StrPack decodes binary streams to Julia composite types, handling stream endianness and padding bytes for the source ABI along the way. StrPack also encodes instances of Julia composite types to binary streams, setting endianness and adding padding if required to meet an ABI. Along with Julia's `IOString` type, StrPack can also be used to convert between Julia composite types and buffers suitable for some C function arguments.
+
+StrPack is not a serializer/deserializer. StrPack only handles Julia's [bits types](http://docs.julialang.org/en/latest/manual/types/#id1) or user types for which `read(io, ::UserType)` and `write(io, data::UserType)` have been defined. However, you could use StrPack to build those things.