summary refs log tree commit diff stats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a8d8ceb
--- /dev/null
+++ b/README.md
@@ -0,0 +1,13 @@
+# Serde Transmute
+
+Transmute objects through serde!
+
+This crate allows converting a `Serialize` value into a `Deserialize` type.
+
+## Caveats
+
+The main caveat of note is that `Serialize` is not lifetime-aware, so the
+`Deserialize` (or `DeserializeSeed`) cannot borrow from it.
+
+But we don't care because this crate was built to power parts of `datafu`.
+And it's pretty good at that.