library-mirrors/bitser
1
0
Fork 0
mirror of https://github.com/gvx/bitser.git synced 2024-11-24 06:54:20 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

update README

Browse Source
This commit is contained in:
Robin Wellner 2016-02-16 02:26:13 +01:00
parent 93de15580f
commit 95611fecfb
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -10,15 +10,17 @@ Serializes and deserializes Lua values with LuaJIT.
bitser.register('someResource', someResource) bitser.register('someResource', someResource)
bitser.registerClass(SomeClass) bitser.registerClass(SomeClass)
serializedData = bitser.dumps(someData) serializedString = bitser.dumps(someValue)
someData = bitser.loads(serializedData) someValue = bitser.loads(serializedString)
serializedData = love.filesystem.newFileData("filename")
someValue = bitser.loadData(serializedData:getPointer())
Pull requests, bug reports and other feedback welcome! :heart: Pull requests, bug reports and other feedback welcome! :heart:
## Why would I use this? ## Why would I use this?
Because it's fast. Because it produces tiny output. Because the name means "snappier" Because it's fast. Because it produces tiny output. Because the name means "snappier"
or "unfriendlier" in Dutch. Because it's safe to use with untrusted data. or "unfriendlier" in Dutch. Because it's (mostly) safe to use with untrusted data.
Because it's inspired by [binser](https://github.com/bakpakin/binser), which is great. Because it's inspired by [binser](https://github.com/bakpakin/binser), which is great.