README.md in paquito-0.7.0 vs README.md in paquito-0.8.0
- old
+ new
@@ -1,8 +1,8 @@
# Paquito
-`Paquito` provies utility classes to define optimized and evolutive serializers.
+`Paquito` provides utility classes to define optimized and evolutive serializers.
## Installation
Add this line to your application's Gemfile:
@@ -59,9 +59,19 @@
2 => MessagePack,
)
coder.dump([1]) # => "\x01[1]"
coder.load("\x00---\n:foo: 42") # => { foo: 42 }
```
+
+### `SingleBytePrefixVersionWithStringBypass`
+
+Works like `Paquito::SingleBytePrefixVersion` except that versions `253`, `254` and `255` are reserved for serializing strings
+in an optimized way.
+
+When the object to serialize is an `UTF-8`, `ASCII` or `BINARY` string, rather than invoking the underlying serializer, it simply
+prepends a single byte to the string which indicates the encoding.
+
+The larger the string the larger the speed gain is, e.g. for a 1MB string, it's over 500x faster than going through `MessagePack` or `Marshal`.
### `CommentPrefixVersion`
Similar to the single byte prefix, but meant to be human readable and to allow for migrating unversioned payloads.