Added NPM and PNPM installation in README.md#1149
Conversation
I-am-Pritam-20
left a comment
I-am-Pritam-20
left a comment
There was a problem hiding this comment.
Check for the commands exist or not
npm < ios | android >
pnpm < ios | android >
| <br> | ||
| <details> | ||
| <summary><strong>Check for NPM Installation</strong></summary> | ||
|
|
||
| ```bash | ||
| npm install react-native-executorch | ||
|
|
||
| # For Expo projects, you need to install expo resource fetcher | ||
| npm install react-native-executorch-expo-resource-fetcher | ||
| npm install expo-file-system expo-asset | ||
|
|
||
| # For bare React Native projects, you need to install bare resource fetcher | ||
| npm install react-native-executorch-bare-resource-fetcher | ||
| npm install @dr.pogodin/react-native-fs @kesha-antonov/react-native-background-downloader | ||
|
|
||
| # Depending on the platform, choose either iOS or Android | ||
| npm < ios | android > | ||
| ``` | ||
| </details> | ||
| <br> | ||
| <details> | ||
| <summary><strong>Check for PNPM Installation</strong></summary> | ||
|
|
||
| ```bash | ||
| pnpm install react-native-executorch | ||
|
|
||
| # For Expo projects, you need to install expo resource fetcher | ||
| pnpm install react-native-executorch-expo-resource-fetcher | ||
| pnpm install expo-file-system expo-asset | ||
|
|
||
| # For bare React Native projects, you need to install bare resource fetcher | ||
| pnpm install react-native-executorch-bare-resource-fetcher | ||
| pnpm install @dr.pogodin/react-native-fs @kesha-antonov/react-native-background-downloader | ||
|
|
||
| # Depending on the platform, choose either iOS or Android | ||
| pnpm < ios | android > | ||
| ``` | ||
| </details> | ||
| <br> |
There was a problem hiding this comment.
I don't think these new lines are needed here. Could you remove these manual <br>s?
There is no such command as |
|
Then devloper must have Then publishing package to Is this package created with |
No, developer doesn't need to use yarn. Correct commands are |
|
This is required so that if a new developer (as a user only of this package) having npm or pnpm installed in the system and directly go through the github README , then he/she should atleast get to know that this package can be used completely with npm or pnpm too. Because still a doc is a doc. And should clarify the minimal doubts. This is just my perspective.🙂 You can add this or close this, as you and your team wish 🫡. And also if npm build scripts will be configured then during the build time the developer's machine will get the compiled codes(already compiled with type safety) and performance may increase, lesser load on CPU + memory. |
The package is shipped pre-built to the npm registry; all three package managers fetch the same compiled artifact, so install-time CPU/memory and runtime performance are unaffected by the choice. At this moment I can agree on one liner instead of three separate blocks: |
|
"Would this be ok" . Hah I am not very used to with this line 😂. And it will be okay if you are not getting back to me. 😂 Btw appreciated the conversation 🫡. I know you guys will definitely find some solution for that. |
- README: replace accordion blocks with a one-line note that npm/pnpm work too; mirror the note in es/fr/cn/pt/in translations - docs/getting-started: split the bulky combined install block into separate steps (core package, then Expo or bare resource fetcher), with small per-package-manager tabs in each step - docs/loading-models: add npm/pnpm tabs alongside the yarn commands Co-Authored-By: Pritam <pritamnanda504@gmail.com>
2 participants
Description
Added NPM and PNPM installation in README.md with details+ summary tag. Atleast new developers won't get scared if they are using npm and suddenly need yarn
Introduces a breaking change?
Type of change
Tested on
Testing instructions
Screenshots
Related issues
Checklist
Additional notes