Skip to content

Commit e183197

Browse files
committed
docs: development
1 parent 54e0da3 commit e183197

File tree

2 files changed

+26
-6
lines changed

2 files changed

+26
-6
lines changed

DEVELOPMENT.md

Lines changed: 26 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,32 @@
11
# Development Guide
22

3+
## shared-storage
34

5+
The **shared-storage** module is a **Kotlin Multiplatform (KMP)** library that encapsulates the storage logic.
6+
It is used as the core backend for android and apple platforms.
7+
8+
### Android
9+
10+
Android's `shared-storage` is distributed via maven local repo, which is then consumed by React Native module.
11+
To build the sdk, run:
12+
13+
```shell
14+
yarn build:android
15+
```
16+
17+
The artifact is then moved to `packages/async-storage/android/local_repo` for distribution.
18+
19+
### Apple (iOS/macOS)
20+
21+
`shared-storage` for apple platforms is distributed as `xcframework` containing both Debug and Release binaries.
22+
23+
To build it:
24+
25+
```shell
26+
yarn build:apple
27+
```
28+
29+
The artifact is then moved to `packages/async-storage/apple/Frameworks` for distribution.
430

531
## Documentation
632

@@ -38,8 +64,3 @@ Run `mike deploy` to deploy docs and mark them as latest:
3864
```shell
3965
mike deploy -u -r docs --push DOCS_VERSION_FROM_PCK_JSON latest
4066
```
41-
42-
43-
44-
45-

scripts/build-native-lib.sh

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,6 @@ build_apple() {
3636
echo "👷 Assembling apple shared-storage"
3737
./gradlew :$MODULE_NAME:$APPLE_BUILD_TASK
3838

39-
4039
echo "recreate Frameworks dir"
4140
rm -rf $APPLE_RN_OUTPUT_DIR
4241
mkdir $APPLE_RN_OUTPUT_DIR

0 commit comments

Comments
 (0)