database: add feature flags list

rust-nostr · Nov 9, 2023 · 70d8941 · 70d8941
1 parent 3bce5f5
commit 70d8941
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/crates/nostr-database/README.md b/crates/nostr-database/README.md
@@ -12,6 +12,14 @@ This library cointains the `NostrDatabase` and `NostrDatabaseExt` traits. You ca
 * RocksDB (desktop, server and mobile devices), available at [`nostr-rocksdb`](https://crates.io/crates/nostr-rocksdb)
 * IndexedDB (web), available at [`nostr-indexeddb`](https://crates.io/crates/nostr-indexeddb)
 
+## Crate Feature Flags
+
+The following crate feature flags are available:
+
+| Feature             | Default | Description                                                                              |
+| ------------------- | :-----: | ---------------------------------------------------------------------------------------- |
+| `flatbuf`           |   No    | Enable `flatbuffers` de/serialization for nostr events                                   |
+
 ## State
 
 **This library is in an ALPHA state**, things that are implemented generally work but the API will change in breaking ways.