📝 add readme

exactly · Nov 24, 2023 · ac58668 · ac58668
1 parent f518518
commit ac58668
Showing 1 changed file with 30 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,30 @@
+# @exactly/mobile
+
+## development
+
+### requirements
+
+- [bun](https://bun.sh/docs/installation)
+- react-native [dependencies per platform](https://reactnative.dev/docs/environment-setup?guide=native)
+
+### bun lockfile setup
+
+```shell
+git config --global diff.lockb.textconv bun
+git config --global diff.lockb.binary true
+```
+
+### install
+
+```shell
+bun install
+```
+
+### run
+
+```shell
+bun web # for web
+
+bun android # for native android app
+bun ios # for native ios app
+```