added logo and use case diagram replaced by mind map

Author: raydac

.projectKnowledge/JBBP.mmd

@@ -0,0 +1,137 @@
+Mind Map generated by NB MindMap plugin   
+> __version__=`1.0`,showJumps=`true`
+---
+
+# Java Binary<br/>Block Parser
+
+## License
+> fillColor=`#33CC00`,leftSide=`true`
+
+
+### Apache License 2\.0
+> fillColor=`#99FF00`
+
+
+## Compatibility
+> fillColor=`#CCCCFF`,leftSide=`true`
+
+
+### Java 5\+
+> fillColor=`#3399FF`,textColor=`#FFFFCC`
+
+
+### Android 2\.0\+
+> fillColor=`#3399FF`,textColor=`#FFFFCC`
+
+
+## does\.\.\.
+
+### have small size <br/>and no dependencies
+> fillColor=`#33FF66`
+
+
+### have strong <br/>embedded DSL with\.\.\.
+> fillColor=`#CCCCFF`
+
+- TOPIC
+<pre>1528DC7A000A</pre>
+
+#### signed and<br/>unsigned data types
+> fillColor=`#CCCCFF`
+
+
+#### custom processing of<br/>non\-standard data types
+> fillColor=`#CCCCFF`
+
+
+#### arrays and<br/>structures
+> fillColor=`#CCCCFF`
+
+
+#### expressions and another field value<br/>as data length
+> fillColor=`#CCCCFF`
+
+
+#### aligning and skipping data
+> fillColor=`#CCCCFF`
+
+
+### have support for \.\.\.
+> fillColor=`#FFCCCC`
+
+
+#### all bit orders
+> fillColor=`#FFCCCC`
+
+- FILE
+<pre>src/main/java/com/igormaznitsa/jbbp/io/JBBPBitOrder.java</pre>
+
+#### all byte orders
+> fillColor=`#FFCCCC`
+
+- FILE
+<pre>src/main/java/com/igormaznitsa/jbbp/io/JBBPByteOrder.java</pre>
+
+### have annotation to\.\.
+> fillColor=`#CCFFCC`
+
+- FILE
+<pre>src/main/java/com/igormaznitsa/jbbp/mapper/Bin.java</pre>
+
+#### map parsed data to class fields
+> fillColor=`#CCFFCC`
+
+
+#### serialize field data into stream
+> fillColor=`#CCFFCC`
+
+
+### can make text representation<br/>of parsed data
+> fillColor=`#FFFFCC`
+
+
+## Main parts
+> fillColor=`#00FFFF`,leftSide=`true`
+
+
+### Streams
+> fillColor=`#FF99FF`
+
+
+#### JBBPBitInputStream
+> fillColor=`#FF99FF`
+
+
+#### JBBPBitOutputStream
+> fillColor=`#FF99FF`,leftSide=`true`
+
+- FILE
+<pre>src/main/java/com/igormaznitsa/jbbp/io/JBBPBitOutputStream.java</pre>
+
+### DSL
+> fillColor=`#66FF00`,topicLinkUID=`1528DC7A000A`,leftSide=`true`
+
+
+#### JBBPParser
+> fillColor=`#66FF00`
+
+- FILE
+<pre>src/main/java/com/igormaznitsa/jbbp/JBBPParser.java</pre>
+
+### Write binary<br/>data
+> fillColor=`#00CCCC`,leftSide=`true`
+
+
+#### JBBPOut
+> fillColor=`#00CCCC`
+
+
+### Convert To Text
+> fillColor=`#FFFFCC`,leftSide=`true`
+
+
+#### JBBPTextWriter
+> fillColor=`#FFFFCC`
+
+- FILE
+<pre>src/main/java/com/igormaznitsa/jbbp/utils/JBBPTextWriter.java</pre>

README.md

@@ -6,7 +6,7 @@ Introduction
 Sometime it is very important to parse in Java some binary block data, may be not in very fast way but structures can have complex format and byte and bit orders can be very different. In Python we have [the Struct package](https://docs.python.org/2/library/struct.html) for operations to parse binary blocks but in Java such operations look a bit verbose and take some time to be programmed, so that I decided during my vacation to develop a framework which would decrease verbosity for such operations in Java and will decrease my work in future because I am too lazy to write a lot of code.<br>
 p.s.<br>
 For instance I have been very actively using the framework in [the ZX-Poly emulator](https://github.com/raydac/zxpoly) to parse snapshot files and save results.   
-![Use cases](https://github.com/raydac/java-binary-block-parser/blob/master/docs/jbbp_usecases.png)
+![Use cases](https://github.com/raydac/java-binary-block-parser/blob/master/docs/jbbp_mm.png)
 License
 ========
 The Framework is under [Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0).