Skip to content

Commit a4fb049

Browse files
committed
Add warning to readme
1 parent 82990f5 commit a4fb049

1 file changed

Lines changed: 8 additions & 0 deletions

File tree

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@
66

77
The typedstream format is a binary serialization protocol designed for `C` and `Objective-C` data structures. It is primarily used in Apple's Foundation framework, specifically within the `NSArchiver` and `NSUnarchiver` classes.
88

9+
## ⚠️ Warning
10+
11+
This library is in alpha state; the API surface may change.
12+
913
### Quick Start
1014

1115
```rust,no_run
@@ -32,6 +36,10 @@ typedstream.resolve_properties(root)
3236
.for_each(|prop| println!("{:#?}", prop))
3337
```
3438

39+
### Detailed examples
40+
41+
This crate is heavily used by [`imessage-database`](https://crates.io/crates/imessage-database)'s [`body`](https://github.com/ReagentX/imessage-exporter/blob/develop/imessage-database/src/tables/messages/body.rs) module.
42+
3543
## Origin
3644

3745
The format is derived from the data structure used by `NeXTSTEP`'s `NXTypedStream` APIs.

0 commit comments

Comments
 (0)