added Readme + LICENSE

Author: pro100andrey

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 https://github.com/pro100andrey
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1 +1,94 @@
-# pro_binary
+# pro_binary - Binary Read/Write Library
+
+This library provides efficient binary reading and writing capabilities in Dart. It supports various data types and endianness, making it ideal for low-level data manipulation and network protocols.
+
+## Features
+
+- Read and write operations for various data types (e.g., int8, uint8, int16, uint16, int32, uint32, int64, uint64, float32, float64).
+- Support for both big-endian and little-endian formats.
+- Efficient memory management with dynamic buffer resizing.
+
+## Installation
+
+Add this to your package's `pubspec.yaml` file:
+``` yaml
+dependencies:
+  pro_binary: ^1.0.0
+```
+
+Then, run `pub get` to install the package.
+
+## Usage
+
+### Writing Binary Data
+
+``` dart
+import 'package:binary_rw/binary_writer.dart';
+
+void main() {
+  final writer = BinaryWriter()
+    ..writeUint8(42)
+    ..writeInt8(-42)
+    ..writeUint16(65535, Endian.little)
+    ..writeInt16(-32768, Endian.little)
+    ..writeUint32(4294967295, Endian.little)
+    ..writeInt32(-2147483648, Endian.little)
+    ..writeUint64(9223372036854775807, Endian.little)
+    ..writeInt64(-9223372036854775808, Endian.little)
+    ..writeFloat32(3.14, Endian.little)
+    ..writeFloat64(3.141592653589793, Endian.little)
+    ..writeBytes([1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 100, 200, 255]);
+
+  final bytes = writer.takeBytes();
+  print(bytes);
+}
+```
+
+### Reading Binary Data
+
+``` dart
+import 'package:binary_rw/binary_reader.dart';
+
+void main() {
+  final buffer = Uint8List.fromList([
+    42, 214, 255, 255, 0, 128, 255, 255, 255, 255, 0, 0, 0, 128,
+    255, 255, 255, 255, 255, 255, 255, 127, 0, 0, 0, 0, 0, 0, 0, 128,
+    195, 245, 72, 64, 24, 45, 68, 84, 251, 33, 9, 64,
+    1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 100, 200, 255
+  ]);
+
+  final reader = BinaryReader(buffer);
+
+  final uint8 = reader.readUint8();
+  final int8 = reader.readInt8();
+  final uint16 = reader.readUint16(Endian.little);
+  final int16 = reader.readInt16(Endian.little);
+  final uint32 = reader.readUint32(Endian.little);
+  final int32 = reader.readInt32(Endian.little);
+  final uint64 = reader.readUint64(Endian.little);
+  final int64 = reader.readInt64(Endian.little);
+  final float32 = reader.readFloat32(Endian.little);
+  final float64 = reader.readFloat64(Endian.little);
+  final bytes = reader.readBytes(13);
+
+  print([uint8, int8, uint16, int16, uint32, int32, uint64, int64, float32, float64, bytes]);
+}
+```
+
+## Running Tests
+
+To run the tests, use the following command:
+
+``` bash
+dart test
+```
+
+This will execute all tests in the `test` directory and provide a summary of the results.
+
+## Contributing
+
+Feel free to open issues or submit pull requests on GitHub. Contributions are always welcome!
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for more details.