Index: pkg/serialization/README.md |
diff --git a/pkg/serialization/README.md b/pkg/serialization/README.md |
new file mode 100644 |
index 0000000000000000000000000000000000000000..aaa71653b4d56ac0cc39a4f3b3fdf004c7f8ab14 |
--- /dev/null |
+++ b/pkg/serialization/README.md |
@@ -0,0 +1,12 @@ |
+A general-purpose serialization facility for Dart Objects. |
+ |
+This provides the ability to save and restore objects to pluggable |
+Formats using pluggable Rules. |
+These rules can use mirrors or be hard-coded. The main principle |
+is using only public APIs on the serialized objects, so changes to the |
+internal representation do not break previous serializations. It also handles |
+cycles, different representations, filling in known objects on the |
+receiving side, and other issues. It is not as much intended for |
+APIs using JSON to pass acyclic structures without class information, |
+and is fairly heavweight and expensive for doing that compared to simpler |
+approaches. |