Skip to content

Commit 29944a9

Browse files
authored
Merge pull request #35 from contentpass/DOCS-improve-contributing-docs
docs: improve contributing docs
2 parents 160d158 + 5c36032 commit 29944a9

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

docs/CONTRIBUTING.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,9 @@ yarn
4141

4242
> Since the project relies on Yarn workspaces, you cannot use [`npm`](https://github.com/npm/cli) for development.
4343
44-
```sh
45-
4644
The [example app](/example/) and [expo example app](/expoExample/) demonstrates usage of the library. You need to run it to test any changes you make.
45+
The default [configuration](../sharedExample/src/contentpassConfig.ts) in example apps points to contentpass testing environment.
46+
You can change it to any other environment by updating the `contentpassConfig.ts` file.
4747

4848
It is configured to use the local version of the library, so any changes you make to the library's source code will be reflected in the example apps.
4949
Changes to the library's JavaScript code will be reflected in the example apps without a rebuild, but native code changes will require a rebuild of the example app.
@@ -71,7 +71,10 @@ OR
7171
yarn expo-example start
7272
```
7373

74-
To run the example app on Android:
74+
**NOTE**: The `expo start` command only runs the development server. To build and install the app, use the commands
75+
described below: `yarn expo-example android`, `yarn expo-example ios`.
76+
77+
To run the example apps on Android:
7578

7679
```sh
7780
yarn example android
@@ -83,7 +86,7 @@ OR
8386
yarn expo-example android
8487
```
8588

86-
To run the example app on iOS:
89+
To run the example apps on iOS:
8790

8891
**NOTE**: You need to run `bundle install` in the `example/ios` directory before running the following command.
8992
`bundle install` commands is responsible for installing the required dependencies for the iOS project.

0 commit comments

Comments
 (0)