Skip to content

Commit

Permalink
Add description, add documentation and install tutorial to readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
SecondNewtonLaw committed Jul 22, 2024
1 parent 9a97de7 commit 6f5baa7
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 6 deletions.
13 changes: 9 additions & 4 deletions README.md
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).

Expand All @@ -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.
5 changes: 3 additions & 2 deletions wally.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
[package]
name = "dottik/tabletobuffer"
version = "0.1.0"
name = "secondnewtonlaw/tabletobuffer"
description = "A utility to convert tables into buffers"
version = "0.1.1"
registry = "https://github.com/UpliftGames/wally-index"
realm = "shared"
license = "MIT"
Expand Down

0 comments on commit 6f5baa7

Please sign in to comment.