README.rdoc in nu_wav-0.4.2 vs README.rdoc in nu_wav-0.4.3
- old
+ new
@@ -1,11 +1,35 @@
-= nu_wav
+= NuWav Ruby Gem (nu_wav)
+[](https://travis-ci.org/kookster/nu_wav)
+
NuWav is a pure Ruby audio WAVE file parser and writer.
-It currently has support for basic WAVE files, Broadcast Wave Format (bext and mext chunks), and cart chunk.
+It currently has support for basic WAVE files, Broadcast Wave Format (bext and mext chunks), and the cart chunk.
+It will parse other chunks, but doesn't necessarily provide specific parsing for them.
-Other chunks types in the WAVE are not yet supported.
+It will look for a class based on the chunk name, so if you want to add 'fact' chunk parsing, you need to define a class like this (n.b. 'fact' chunks are already supported, this is an example from the code):
+
+```
+module NuWav
+ class FactChunk < NuWav::Chunk
+ attr_accessor :samples_number
+
+ def parse
+ @samples_number = read_dword(0)
+ end
+
+ def to_s
+ "<chunk type:fact samples_number:#{@samples_number} />"
+ end
+
+ def to_binary
+ "fact" + write_dword(4) + write_dword(@samples_number)
+ end
+
+ end
+end
+```
== Note on Patches/Pull Requests
* Fork the project.
* Make your feature addition or bug fix.