Skip to content
This repository was archived by the owner on Nov 14, 2022. It is now read-only.

Commit 03c5228

Browse files
Updated README with info about how to run on iOS
Signed-off-by: Karim Stekelenburg <[email protected]>
1 parent 5516b20 commit 03c5228

File tree

1 file changed

+15
-5
lines changed

1 file changed

+15
-5
lines changed

README.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ Aries Mobile Agent React Native is a mobile agent built on top of [Aries Framewo
1414
- [Docker Compose](https://docs.docker.com/compose/install/)
1515
- [React Native Development Environment](https://reactnative.dev/docs/environment-setup)
1616

17+
> For iOS you will also need to install [CocoaPods](https://cocoapods.org/)
18+
1719
Besides the prerequisites listed above, the mobile agent relies on an external mediator to receive messages. You can start a sample mediator from the Aries Framework JavaScript repo. Run the following to start two sample mediators:
1820

1921
```sh
@@ -52,22 +54,30 @@ const agent = await initAgent({
5254
});
5355
```
5456

55-
### Installing
57+
### Installation
58+
59+
To install the dependencies, run:
5660

5761
```sh
58-
# Install dependencies
5962
yarn install
63+
pod install --project-directory=ios/ # needed for iOS
64+
6065
```
6166

6267
### Running
63-
64-
Only Android is supported at the moment. iOS support will be added soon.
68+
To start the agent, you may run the following commands:
6569

6670
```sh
67-
# Android
6871
yarn android
72+
73+
# or for iOS
74+
# yarn ios --device
75+
6976
```
7077

78+
> Note: the current Indy iOS build included in this repo is not compiled for the architectures required by the iOS simulator.
79+
> Therefore running this project in iOS will **only work on a physical device**
80+
7181
## Contributing
7282

7383
Found a bug? Ready to submit a PR? Want to submit a proposal for your grand idea? See our [CONTRIBUTING](CONTRIBUTING.md) file for more information to get you started!

0 commit comments

Comments
 (0)