diff --git a/README.md b/README.md index f1dcfe59..146916a6 100644 --- a/README.md +++ b/README.md @@ -79,6 +79,7 @@ The NUT documents (**N**otation, **U**sage and **T**erminology) each specify par - eNuts is built using the managed workflow provided by Expo, so the easiest way to run a development environment is their [Expo Go](https://expo.dev/client) app. - NodeJS 16 or higher. +- pnpm [pnpm.io](https://pnpm.io/installation) ## 👏 Contribute @@ -102,8 +103,8 @@ The process of proposing a change to eNuts can be summarized as follows: 1. Verify the open [issues](https://github.com/cashubtc/eNuts/issues) and [discussions](https://github.com/cashubtc/eNuts/discussions) to see if a related topic is available. 2. Fork the repository and create your branch from `main` 3. Make the desired changes to the sources and add tests if required. -4. Ensure the test suite passes, either locally with `npm run test` or on CI once you opened a pull request. -5. Make sure your code lints with `npm run lint` +4. Ensure the test suite passes, either locally with `pnpm test` or on CI once you opened a pull request. +5. Make sure your code lints with `pnpm lint` 6. Push the changes to your fork. 7. Create a pull request to the eNuts repository. 8. Request a review, link a related issue and describe your pull request. @@ -114,8 +115,8 @@ If all goes well, your pull request will be merged. If it is not merged, maintai ## 🚀 Getting started 1. Fork this repository and create a local clone. -2. Navigate inside the repository and run `npm i` -3. Start the Expo dev server by running `npm run start` +2. Navigate inside the repository and run `pnpm i` +3. Start the Expo dev server by running `pnpm start` 4. Download the [Expo Go](https://expo.dev/client) app. 5. Scan the QR code provided by your terminal using the app (iOS users will have to use the Camera app). 6. A browser tab will be opened. Press the "Expo Go" button in the bottom of the page.