From ab15e7d0c04d4406fba2ba491ad5ffc69b7f7ddf Mon Sep 17 00:00:00 2001 From: Andrei Date: Fri, 31 Oct 2025 10:30:59 +0200 Subject: [PATCH 1/2] docs: Mention mmkv being an in-memory store Adds additional information about MMKV being an in-memory store backed by `mmap` to avoid confusion. This gives more context for people that do not know what `mmap` or `MMKV` are or how they work. I, personally, made the mistake of persisting tanstack query's cache with `maxAge: Infinity` to `react-native-mmkv`, without ever realizing that it is an in-memory store and that I am filling the RAM of my users' devices. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d41e8f17..e9403c8f 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,7 @@
-* **MMKV** is an efficient, small mobile key-value storage framework developed by WeChat. See [Tencent/MMKV](https://github.com/Tencent/MMKV) for more information +* **MMKV** is an efficient, small, in-memory synced with files (backed by mmap) mobile key-value storage framework developed by WeChat. See [Tencent/MMKV](https://github.com/Tencent/MMKV) for more information * **react-native-mmkv** is a library that allows you to easily use **MMKV** inside your React Native app through fast and direct JS bindings to the native C++ library. ## Features From 223fcf8a8c0b3fc526f03027f82a74c5bf7ef4f4 Mon Sep 17 00:00:00 2001 From: Andrei Date: Thu, 6 Nov 2025 18:54:54 +0200 Subject: [PATCH 2/2] chore: bold in-memory and mention mmap later in message --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e9403c8f..fe2e43c0 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,7 @@
-* **MMKV** is an efficient, small, in-memory synced with files (backed by mmap) mobile key-value storage framework developed by WeChat. See [Tencent/MMKV](https://github.com/Tencent/MMKV) for more information +* **MMKV** is an efficient, small, **in-memory** mobile key-value storage framework developed by WeChat. Data is stored using `mmap` which syncs it with files for persistence. See [Tencent/MMKV](https://github.com/Tencent/MMKV) for more information * **react-native-mmkv** is a library that allows you to easily use **MMKV** inside your React Native app through fast and direct JS bindings to the native C++ library. ## Features