Skip to content

Commit 01c8cc8

Browse files
committed
improve docs after #61
1 parent dce87ea commit 01c8cc8

File tree

3 files changed

+9
-2
lines changed

3 files changed

+9
-2
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,11 @@ In addition to ensuring an optimal developer experience in Rust, the modular app
9999
This project was initially motivated by the need for canonical serialization and cryptographic hashing in the [Diem](https://github.com/diem/diem) project (formerly known as "Libra"). In this context, [`serde-name`](serde-name) has been used to provide predictable cryptographic seeds for Rust containers.
100100

101101

102+
## Limitations
103+
104+
This project is built on top of the Rust serialization library [Serde](https://serde.rs/). The data model of `Serde` allows for type constructions that can be difficult to implement in other languages (e.g. using complex types as keys in a map). Currently, the requirements for a language to be officially supported by [`serde-generate`](serde-generate) are not specified and only based on the standard tests in this repo. To guarantee cross-language interoperability, make sure to test code-generation often on your schemas.
105+
106+
102107
## Related projects
103108

104109
### Schemars

serde-generate/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,10 @@ The following programming languages are fully supported as target languages:
2424
* OCaml
2525
* Dart >= 3
2626

27-
The following languages are partially supported and still considered under development:
27+
The following languages are partially supported and/or still considered under development:
2828

2929
* TypeScript 4 (packaged and tested with Deno) [(follow-up issue)](https://github.com/zefchain/serde-reflection/issues/58)
30+
* Solidity (tested with Revm) [(initial PR with discussion)](https://github.com/zefchain/serde-reflection/pull/61)
3031

3132
### Supported Encodings
3233

serde-generate/src/lib.rs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,10 @@
2121
//! * OCaml
2222
//! * Dart >= 3
2323
//!
24-
//! The following languages are partially supported and still considered under development:
24+
//! The following languages are partially supported and/or still considered under development:
2525
//!
2626
//! * TypeScript 4 (packaged and tested with Deno) [(follow-up issue)](https://github.com/zefchain/serde-reflection/issues/58)
27+
//! * Solidity (tested with Revm) [(initial PR with discussion)](https://github.com/zefchain/serde-reflection/pull/61)
2728
//!
2829
//! ## Supported Encodings
2930
//!

0 commit comments

Comments
 (0)