Skip to content

Update README.md for running the example app #485

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
cameronvoell wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README.md for running the example app #485

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,18 @@ To learn more about XMTP and get answers to frequently asked questions, see the

## Example app built with `xmtp-ios`

Use the [XMTP iOS quickstart app](https://github.com/xmtp/xmtp-ios/tree/main/example) as a tool to start building an app with XMTP. This basic messaging app has an intentionally unopinionated UI to help make it easier for you to build with.
Use the [XMTP iOS Example app](https://github.com/xmtp/xmtp-ios/tree/main/XMTPiOSExample) as a tool to start building an app with XMTP. This basic messaging app has an intentionally unopinionated UI to help make it easier for you to build with.

To learn about example app push notifications, see [Enable the quickstart app to send push notifications](library/src/main/java/org/xmtp/ios/library/push/README.md).
<!--
Commenting out until push notification example is updated
To learn about example app push notifications, see [Enable the quickstart app to send push notifications](library/src/main/java/org/xmtp/ios/library/push/README.md). -->

In order to run the Example app:

1. Using Xcode, open `xmtp-ios/XMTPiOSExample/XMTPiOSExample.xcodeproj`
2. Select simulator target in Xcode
3. Product -> Run
4. After the app starts on your simulator, click generate wallet. Ethereum address can be copied out of console logs.

## Reference docs

Expand Down
Loading