-
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 description, add documentation and install tutorial to readme.
- Loading branch information
1 parent
9a97de7
commit 6f5baa7
Showing
2 changed files
with
12 additions
and
6 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,4 +1,4 @@ | ||
# TableToBuffer | ||
# Table To Buffer | ||
|
||
Table to buffer is a project that aims to create a serializer for _most_ primitive data types inside of Luau (`userdata` is not serialized due to it having to be practically manually done for each instance). | ||
|
||
|
@@ -16,7 +16,12 @@ The serializer building can be done automatically given a table. This project ON | |
|
||
The library follows a Builder pattern to create Deserializers and Serializers. Think of it as something like a Table to JSON, but instead of JSON, is optimized buffers. The order in which the functions for the builder are called matters, as they dictate how big the buffer will be and the position of the data. | ||
|
||
Parsing `userdata` value types is not currently on the roadmap. | ||
Parsing `userdata` value types is not currently on the roadmap, and it may be treated as a side project if it every comes around. | ||
|
||
## How to install? | ||
- Download the `.rbxm` file on the latest release of this project. | ||
- Using wally: | ||
- Add `tabletobuffer = "secondnewtonlaw/[email protected]"` | ||
|
||
## [How to use this?](https://secondnewtonlaw.github.io/TableToBuffer/) | ||
|
||
#### Documentation: | ||
There is no documentation as of now, as the project is early in development. |
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