1. Steffen Dienst
  2. binary

Commits

Steffen Dienst  committed a2f8388

[doc] minimal documention (rather links to tests)

  • Participants
  • Parent commits 81ed3c6
  • Branches master

Comments (0)

Files changed (2)

File .travis.yml

View file
+language: clojure

File README.md

View file
 # binary-dsl
 
-I'm an app. Or maybe I'm a library? I haven't decided yet. 
+This library is a high performance binary parser combinator. It enables reading and writing arbitrary binary data from Java's io streams.  
+
+[![Build Status](https://secure.travis-ci.org/smee/binary.png)](http://travis-ci.org/smee/binary])
 
-The choice is up to you!
 
 ## Usage
 
-FIXME
+Please refer to the tests for now at (https://github.com/smee/binary/blob/master/test/org/clojars/smee/binary/codectests.clj) or the start of an MP3 IDv2 parser at (https://github.com/smee/binary/blob/master/src/org/clojars/smee/binary/demo/mp3.clj).
+More documentation is currently in the pipeline...
 
 ## License
 
-Copyright © 2012 FIXME
+Copyright © 2012 Steffen Dienst
 
 Distributed under the Eclipse Public License, the same as Clojure.