diff --git a/README.md b/README.md index c61adaa..a800abf 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,23 @@ -TODO: - -- eval use of `string_cache` for collection-names, document-names and map-keys -- eval use of `cachemap2` instead of `Arc<_>` at certain points - ## Missing features -- [ ] Mimic transaction behaviour from cloud Firestore (mixed pessimistic and optimistic) -- [ ] Rest of the updates with Transforms -- [ ] Documentation -- [ ] ... +- [ ] Some of the updates with Transforms (such as Maximum and Minimum) +- [ ] Multiplexing listeners in a single stream (used by frontend Firestore SDK) +- [ ] Nearest neighbors search +- [ ] Some field filters (such as ArrayContainsAny and NotIn) +- [ ] Some API's that are not used by NodeJS SDK anymore (such as CreateDocument and Updatedocument) +- [ ] Explain options +- [ ] and many more... search for `unimplemented` to get the idea + +And also missing a lot of documentation. ## Important to know -This is highly experimental software. +This is highly experimental software. We use this in our dev and CI enviroments to get better stability (and performance) while running our extensive unit test suites. ## How to use +### Prerequisites + ```shell brew install protobuf ``` @@ -25,13 +27,13 @@ brew install protobuf Debug mode: ```shell -FIRESTORE_EMULATOR_HOST=127.0.0.1:8080 cargo watch -cx run +FIRESTORE_EMULATOR_HOST=127.0.0.1:8080 cargo run ``` Release mode: ```shell -FIRESTORE_EMULATOR_HOST=127.0.0.1:8080 cargo watch -cx "run --release" +FIRESTORE_EMULATOR_HOST=127.0.0.1:8080 cargo run --release ``` ### Install