README.md in bindata-1.6.0 vs README.md in bindata-1.8.0
- old
+ new
@@ -26,10 +26,17 @@
io = File.open(...)
r = Rectangle.read(io)
puts "Rectangle #{r.name} is #{r.width} x #{r.height}"
```
+BinData provides a _declarative_ way to read and write structured binary data.
+
+This means the programmer specifies *what* the format of the binary
+data is, and BinData works out *how* to read and write data in this
+format. It is an easier (and more readable) alternative to
+ruby's `#pack` and `#unpack` methods.
+
BinData makes it easy to create new data types. It supports all the common
primitive datatypes that are found in structured binary data formats. Support
for dependent and variable length fields is built in.
# Installation
@@ -40,10 +47,10 @@
$ sudo ruby setup.rb
# Documentation
-[http://bindata.rubyforge.org/manual.html](http://bindata.rubyforge.org/manual.html)
+[Read the wiki](http://github.com/dmendel/bindata/wiki).
-or-
$ rake manual