Merge branch 'main' of github.com:mas-bandwidth/serialize

BUILDING.md

@@ -1,5 +1,5 @@
-How to build reliable
-=====================
+How to build serialize
+======================
 
 ## Building on Windows
 
@@ -11,15 +11,15 @@ Once you have Visual Studio installed, go to the command line under the reliable
 
     premake5 vs2019
 
-Open the generated reliable.sln file.
+Open the generated serialize.sln file.
 
 Now you can build the library and run individual test programs as you would for any other Visual Studio solution.
 
 ## Building on MacOS and Linux
 
 First, download and install [premake 5](https://premake.github.io/download.html).
 
-Now go to the command line under the reliable directory and enter:
+Now go to the command line under the serialize directory and enter:
 
     premake5 gmake
 
@@ -30,11 +30,9 @@ Which creates makefiles which you can use to build the source via:
 Then you can run binaries like this:
 
     ./bin/test
-    ./bin/stats
-    ./bin/soak
-    ./bin/fuzz
+    ./bin/examples
 
-If you have questions please create an issue at https://github.com/mas-bandwidth/reliable and I'll do my best to help you out.
+If you have questions please create an issue at https://github.com/mas-bandwidth/serialize and I'll do my best to help you out.
 
 cheers
 

README.md

@@ -1,55 +1,18 @@
-[![Build status](https://github.com/mas-bandwidth/reliable/workflows/CI/badge.svg)](https://github.com/mas-bandwidth/reliable/actions?query=workflow%3ACI)
+[![Build status](https://github.com/mas-bandwidth/serialize/workflows/CI/badge.svg)](https://github.com/mas-bandwidth/serialize/actions?query=workflow%3ACI)
 
 # Introduction
 
-**reliable** is a simple packet acknowledgement system for UDP-based protocols.
+**serialize** is a simple bitpacking serializer for C++.
 
-It has the following features:
+Now you can easily write a bool with only one bit, or serialize any integer value up to 64 bits while taking up only that many bits in the buffer.
 
-1. Acknowledgement when packets are received
-2. Packet fragmentation and reassembly
-3. RTT and packet loss estimates
-
-reliable is stable and production ready.
+A template based serialization system is also included so you can have one serialize function that unifies read and write.
 
 # Author
 
 The author of this library is Glenn Fiedler.
 
-Open source libraries by the same author include: [netcode](https://github.com/mas-bandwidth/netcode) and [yojimbo](https://github.com/mas-bandwidth/yojimbo)
-
-# Source Code
-
-This repository holds the reference implementation of reliable in C.
-
-Other reliable implementations include:
-
-* [reliable Rust implementation](https://github.com/jaynus/reliable.io)
-
-# Contributors
-
-These people are awesome:
-
-* [Walter Pearce](https://github.com/jaynus) - Rust Implementation
-
-# Sponsors
-
-**reliable** was generously sponsored by:
-
-* **Gold Sponsors**
-    * [Remedy Entertainment](http://www.remedygames.com/)
-    * [Cloud Imperium Games](https://cloudimperiumgames.com)
-
-* **Silver Sponsors**
-    * [Moon Studios](http://www.oriblindforest.com/#!moon-3/)
-    * [Mas Bandwidth](https://www.mas-bandwidth.com)
-    * The Network Protocol Company
-
-* **Bronze Sponsors**
-    * Kite & Lightning
-    * [Data Realms](http://datarealms.com)
-
-And by individual supporters on Patreon. Thank you. You made this possible!
+Open source libraries by the same author include: [netcode](https://github.com/mas-bandwidth/netcode), [reliable](https://github.com/mas-bandwidth/netcode) and [yojimbo](https://github.com/mas-bandwidth/yojimbo)
 
 # License