update readme

rzcoder · rzcoder · commit 4a5bc7f85e1c · 2014-05-30T22:42:02.000+06:00
diff --git a/README.md b/README.md
@@ -9,7 +9,28 @@ Convert between JS object and Node.js buffer with rigidly predetermined scheme.
 ```
 
 
-## Example & usage
+## Usage
+
+`require("data-struct")` exports just 3 namespaces:
+
+  * `DataTypes` – dictonary of supported types:
+      * **boolean** – 1 byte
+      * **int8** – 1 byte
+      * **uint8** – 1 byte
+      * **int16** – 2 bytes
+      * **uint16** – 2 bytes
+      * **int32** – 4 bytes
+      * **uint32** – 4 bytes
+      * **float** – 4 bytes
+      * **double** – 8 bytes
+      * **string** – 2 bytes header + string bytes length (max length: 65535 bytes, **not string length!**)
+      * **shortBuffer**  – 2 bytes header  + buffer length (max length: 65535 bytes)
+      * **buffer** – 4 bytes header + buffer length (max length 4294967295 bytes)
+  * `DataReader(buffer, scheme)` – buffer -> object function.
+  * `DataWriter(object, scheme)` – object -> buffer function.
+
+## Example
+
 
 ```javascript
 
@@ -74,20 +95,4 @@ var mapScheme = [[DataTypes.uint8]];
 
 var mapBuf = DataWriter(map, mapScheme);
 var mapClone = DataReader(mapBuf, mapScheme);
-```
-
-
-## Data types
-
-  * **boolean** - 1 byte
-  * **int8** - 1 byte
-  * **uint8** - 1 byte
-  * **int16** - 2 bytes
-  * **uint16** - 2 bytes
-  * **int32** - 4 bytes
-  * **uint32** - 4 bytes
-  * **float** - 4 bytes
-  * **double** - 8 bytes
-  * **string** - 2 bytes header + string bytes length (max length: 65535 bytes, **not string length!**)
-  * **shortBuffer**  - 2 bytes header  + buffer length (max length: 65535 bytes)
-  * **buffer**  - 4 bytes header + buffer length (max length 4294967295 bytes)
+```
diff --git a/package.json b/package.json
@@ -14,6 +14,7 @@
     "node",
     "buffer",
     "object",
+    "serialization",
     "convert"
   ],
   "author": "rzcoder",
