Skip to content

Commit 2db4f62

Browse files
Update README.md
1 parent a810410 commit 2db4f62

File tree

1 file changed

+77
-1
lines changed

1 file changed

+77
-1
lines changed

README.md

Lines changed: 77 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,77 @@
1-
# platform-react-native-modules
1+
# platform-react-native-modules
2+
3+
Monorepo containing reusable React Native / Expo native modules for Telefónica.
4+
5+
The goal of this repository is to centralize native modules that can be reused across multiple React Native projects, avoiding duplication and improving maintainability.
6+
7+
## Repository structure
8+
9+
This repository is organized as a monorepo using Yarn workspaces.
10+
11+
```
12+
platform-react-native-modules/
13+
├─ package.json
14+
├─ yarn.lock
15+
├─ .yarnrc.yml
16+
├─ packages/
17+
│ └─ public/
18+
│ ├─ ios-common-cookies/
19+
│ └─ ...
20+
└─ .github/
21+
```
22+
23+
### Public packages
24+
25+
All reusable packages intended to be published are placed under:
26+
27+
```
28+
packages/public/*
29+
```
30+
31+
These packages are published under the `@telefonica` scope.
32+
33+
## Packages
34+
35+
### @telefonica/ios-common-cookies
36+
37+
Expo iOS native module for synchronizing cookies between `HTTPCookieStorage` and `WKWebView`.
38+
39+
Location:
40+
```
41+
packages/public/ios-common-cookies
42+
```
43+
44+
Install:
45+
```bash
46+
yarn add @telefonica/ios-common-cookies
47+
```
48+
49+
## Development
50+
51+
Install dependencies:
52+
53+
```bash
54+
yarn install
55+
```
56+
57+
Typecheck all workspaces:
58+
59+
```bash
60+
yarn ts:check
61+
```
62+
63+
Build all workspaces:
64+
65+
```bash
66+
yarn build
67+
```
68+
69+
## Publishing
70+
71+
Publishing is done via GitHub Actions using `semantic-release`.
72+
73+
Each package is versioned and released independently.
74+
75+
## License
76+
77+
MIT

0 commit comments

Comments
 (0)