diff --git a/README.md b/README.md index bff524d..0153b68 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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!