docs: flipper support

ammarahm-ed · Jul 28, 2022 · acdd5a5 · acdd5a5 · vercel · Jul 28, 2022
1 parent 81f0c4a
commit acdd5a5
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 0 deletions.
diff --git a/docs/_sidebar.md b/docs/_sidebar.md
@@ -8,6 +8,7 @@
   - [Supported Data Types](datatypes.md)
   - [Redux persist support](redux-persist.md)
   - [Testing with Jest](mockjest.md)
+  - [Flipper support](flipper.md)
 
 - API Reference
 

diff --git a/docs/flipper.md b/docs/flipper.md
@@ -0,0 +1,18 @@
+# Flipper support
+
+Thanks to [pnthach95](https://github.com/pnthach95/flipper-plugin-react-native-mmkv-storage/commits?author=pnthach95) Flipper plugin is finally here. https://github.com/pnthach95/flipper-plugin-react-native-mmkv-storage. It supports logging and manipulating storage values on the fly.
+
+## Features
+
+- Logging on read/write
+- Edit values on the fly. If you use `useMMKVStorage` hook. Values will update automatically.
+
+![gif](https://github.com/pnthach95/flipper-plugin-react-native-mmkv-storage/raw/main/docs/example.gif)
+
+_\* Tested on Flipper v0.152.0, React Native v0.68.2, RN MMKV Storage source code from github_
+
+## Installation
+
+Open Flipper and search on Plugin Manager
+
+![](https://github.com/pnthach95/flipper-plugin-react-native-mmkv-storage/raw/main/docs/manager.png)