From 3821b20973da618d7cf86c8bcd40fc5b14e3accd Mon Sep 17 00:00:00 2001
From: anod221 <a92126@gmail.com>
Date: Thu, 30 Aug 2018 22:15:58 +0800
Subject: [PATCH] Update README.md

---
 README.md | 95 +++++++++++++++++++++++--------------------------------
 1 file changed, 39 insertions(+), 56 deletions(-)

diff --git a/README.md b/README.md
index d9de6c8..5d47007 100644
--- a/README.md
+++ b/README.md
@@ -8,13 +8,14 @@ add the module:
 luaopen_bytearr(L);
 ```
 
+# constant
+ByteArray.LITTLE_ENDIAN - 0   
+ByteArray.BIG_ENDIAN - 1
+
 # constructor
-create( [capacity, [endian]] ) - Create an empty byte array.
-
-init( [param1, param2, ...] ) - Create a byte array with initial bytes. Parameters should be a list of number or table.
-
-load( str ) - Create a byte array with lua string object for read data. This byte array is read-only.
-
+create( [capacity, [endian]] ) - Create an empty byte array.   
+init( [param1, param2, ...] ) - Create a byte array with initial bytes. Parameters should be a list of number or table.   
+load( str ) - Create a byte array with lua string object for read data. This byte array is read-only.   
 return - A ByteArray object.
 
 ```lua
@@ -24,52 +25,34 @@ local z = ByteArray.load( "hello" ) -- create a byte array with a lua string obj
 ```
 
 # method for read data
-readByte() - Read a 8-bit signed integer from byte array.
-
-readUnsignedByte() - Read a 8-bit unsigned integer from byte array.
-
-readShort() - Read a 16-bit signed integer from byte array.
-
-readUnsignedShort() - Read a 16-bit unsigned integer from byte array.
-
-readInt() - Read a 32-bit signed integer from byte array.
-
-readUnsignedInt() - Read a 32-bit unsigned integer from byte array.
-
-readFloat() - Read a 32-bit float from byte array.
-
-readDouble() - Read a 64-bit float from byte array.
-
-readCString() - Read a string end with \0 from byte array.
-
-return - A lua number object.
+readByte() - Read a 8-bit signed integer from byte array.   
+readUnsignedByte() - Read a 8-bit unsigned integer from byte array.   
+readShort() - Read a 16-bit signed integer from byte array.   
+readUnsignedShort() - Read a 16-bit unsigned integer from byte array.   
+readInt() - Read a 32-bit signed integer from byte array.   
+readUnsignedInt() - Read a 32-bit unsigned integer from byte array.   
+readFloat() - Read a 32-bit float from byte array.   
+readDouble() - Read a 64-bit float from byte array.   
+readCString() - Read a string end with \0 from byte array.   
+return - data read
 
 ```lua
-local t = ByteArray.init( 1, 2, 3, 4, 5, 6 ) 
-local a = t:readByte() -- a == 1 
-local b = t:readUnsignedByte() -- b == 2 
-local c = t:readShort() -- c == 0x0403 
+local buf = ByteArray.init( 1, 2, 3, 4, 5, 6 ) 
+local a = buf:readByte() -- a == 1 
+local b = buf:readUnsignedByte() -- b == 2 
+local c = buf:readShort() -- c == 0x0403 
 ```
 
 # method for write data
-writeByte( s8 ) - Write a 8-bit signed integer to byte array.
-
-writeUnsignedByte( u8 ) - Write a 8-bit unsigned integer to byte array.
-
-writeShort( s16 ) - Write a 16-bit signed integer to byte array.
-
-writeUnsignedShort( u16 ) - Write a 16-bit unsigned integer to byte array.
-
-writeInt( s32 ) - Write a 32-bit signed integer to byte array.
-
-writeUnsignedInt( u32 ) - Write a 32-bit unsigned integer to byte array.
-
-writeFloat( f32 ) - Write a 32-bit float to byte array.
-
-writeDouble( f64 ) - Write a 64-bit float to byte array.
-
-writeCString( str ) - write a string end with \0 to byte array.
-
+writeByte( s8 ) - Write a 8-bit signed integer to byte array.   
+writeUnsignedByte( u8 ) - Write a 8-bit unsigned integer to byte array.   
+writeShort( s16 ) - Write a 16-bit signed integer to byte array.   
+writeUnsignedShort( u16 ) - Write a 16-bit unsigned integer to byte array.   
+writeInt( s32 ) - Write a 32-bit signed integer to byte array.   
+writeUnsignedInt( u32 ) - Write a 32-bit unsigned integer to byte array.   
+writeFloat( f32 ) - Write a 32-bit float to byte array.   
+writeDouble( f64 ) - Write a 64-bit float to byte array.   
+writeCString( str ) - write a string end with \0 to byte array.   
 return - The ByteArray object itself.
 
 ```lua
@@ -78,8 +61,7 @@ buf:writeByte(1):writeByte(2):writeInt(0x0403)
 ```
 
 # method for copying data between ByteArray object
-readBytes( to[, offset, length] ) - Read data to first parameter(a ByteArray object), the range for the target byte array is start from offset with length. 
-
+readBytes( to[, offset, length] ) - Read data to first parameter(a ByteArray object), the range for the target byte array is start from offset with length.    
 writeBytes( from[, offset, length] ) - Write data from first parameter(a ByteArray object), the range for the data is start from offset with length. 
 
 ```lua
@@ -89,7 +71,7 @@ buf:readBytes( d )
 ```
 
 # member position
-start position for reading / writing data.
+Start position for reading / writing data.
 
 ```lua
 local buf = ByteArray.init( 1, 2, 3, 4, 5 )
@@ -100,17 +82,17 @@ print( buf.position ) -- 5
 ```
 
 # member length
-set / get length
+Set / get length.
 
 ```lua
 local buf = ByteArray.init( 1,2,3,4,5,6,7 )
 print( buf.length )
 buf.length = 4
-for i=1, #buf do print(buf[i]) end
+for i=1, #buf do print(buf[i]) end -- 1 2 3 4
 ```
 
 # member endian
-set / get endian
+Set / get endian.
 
 ```lua
 local buf = ByteArray.init(2,3)
@@ -118,10 +100,11 @@ buf.endian = ByteArray.LITTLE_ENDIAN
 ```
 
 # indexing
-index start from 1 to length. If out of range, return -1.
+Index start from 1 to length. If out of range, return -1.
 
 ```lua
 local buf = ByteArray.init(2,3)
-print(buf[1])
-print(buf[2])
+print(buf[1]) -- 2
+print(buf[2]) -- 3
+print(buf[3]) -- -1
 ```