forked from funcool/octet
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add goals and faq sections to the doc.
- Loading branch information
Andrey Antukh
committed
Mar 1, 2015
1 parent
07608d6
commit efdc8c6
Showing
2 changed files
with
22 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,3 @@ | ||
# Bytebuf | ||
# Octet | ||
|
||
A library for working with bytes. | ||
A clojure(script) library for working with binary data. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -12,8 +12,15 @@ Andrey Antukh, <[email protected]> | |
Working with raw bytes is tedious, and sometimes the language abstractions for working | ||
with bytes is not very pleasant. | ||
|
||
_octet_ library offers a simple api for working with raw byte arrays and compose binary protocols | ||
for two most used clojure implementations: clojure (jvm) and clojurescript (javascript). | ||
_octet_ library offers a simple api for clojure (jvm) and clojurescript (js) that makes | ||
working with bytebuffer painless. | ||
|
||
This is a short list of project goals: | ||
|
||
- Not to be intrusive (no bytebuffer wrapping). | ||
- Provide host independent abstraction (in most possible way). | ||
- Partial deserialization (TODO). | ||
- Composability. | ||
|
||
|
||
== Project Maturity | ||
|
@@ -429,6 +436,17 @@ implements the same abstraction and can be used in read or write operations. | |
- more function for create compositions like repeated type, or key value pairs. | ||
|
||
|
||
== FAQ | ||
|
||
*What is the difference with _buffy_?* | ||
|
||
*Buffy* is a excelent library, and I have used it in some circumstances, but is has some things that I personally don't like: | ||
|
||
- It works only with netty bytebuf and I need an abstraction for work with different implementations, including in clojurescript. | ||
- It has slightly strange and not uniform api when dynamic frames (arbitrary length size types) are used. _octet_ offers unified api for both type of specs. | ||
- It wraps bytebuf in a self defined type. _octet_ is a lightweight abstraction that works over host implementations, without wrapping them. | ||
|
||
|
||
== How to Contribute? | ||
|
||
=== Philosophy | ||
|