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

Commit

Permalink
Updated README with info about how to run on iOS
Browse files Browse the repository at this point in the history
Signed-off-by: Karim Stekelenburg <karim@animo.id>
  • Loading branch information
karimStekelenburg committed Jan 14, 2021
1 parent 5516b20 commit 03c5228
Showing 1 changed file with 15 additions and 5 deletions.
20 changes: 15 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ Aries Mobile Agent React Native is a mobile agent built on top of [Aries Framewo
- [Docker Compose](https://docs.docker.com/compose/install/)
- [React Native Development Environment](https://reactnative.dev/docs/environment-setup)

> For iOS you will also need to install [CocoaPods](https://cocoapods.org/)
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:

```sh
Expand Down Expand Up @@ -52,22 +54,30 @@ const agent = await initAgent({
});
```

### Installing
### Installation

To install the dependencies, run:

```sh
# Install dependencies
yarn install
pod install --project-directory=ios/ # needed for iOS

```

### Running

Only Android is supported at the moment. iOS support will be added soon.
To start the agent, you may run the following commands:

```sh
# Android
yarn android

# or for iOS
# yarn ios --device

```

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

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!
Expand Down

0 comments on commit 03c5228

Please sign in to comment.