diff --git a/Sample/README.md b/Sample/README.md new file mode 100644 index 0000000..4a31965 --- /dev/null +++ b/Sample/README.md @@ -0,0 +1,34 @@ +# Sendbird Chat SwiftUI Sample +Sendbird Chat SwiftUI is a development kit with a declarative user interface, enabling easy and fast integration of standard chat features into new or existing client apps. This repository contains a sample app demonstrating the use of Sendbird Chat SwiftUI. +Learn more about Sendbird Chat SwiftUI in the [documentation](https://sendbird.com/docs/chat/uikit/v3/swiftui/overview). For assistance or questions, visit [our community](https://community.sendbird.com). + +## Screenshots +![Screenshot](screenshots/screenshots.png) + +## How to Use the Sample App + +### 1. Clone the Repository + +```bash +git clone git@github.com:sendbird/sendbird-swiftui-ios.git +``` + +### 2. Open in Xcode + +Navigate to the sendbird-swiftui-ios/Sample directory and open it in Xcode. Make sure to open the sendbird-swiftui-ios/Sample/Sample.xcodeproj file. + +### 3. Run the Sample App +Run the sample app on your simulator or device. + +![Sample Screenshot](screenshots/run_sample.png) + +### 4. Test with Your Data +Sample Screenshot + +For user ID and nickname, you can enter any values you like. The app will run in guest mode. + +> Note: Avoid using guest mode in production. + +## Customize with Your Data + +To tailor the sample app to your needs, replace the default app ID with your own. You can obtain this by [creating a Sendbird application from the dashboard](https://dashboard.sendbird.com). You can also add your own data on the dashboard to test, allowing you to experience the app with data from your Sendbird application. \ No newline at end of file diff --git a/Sample/screenshots/run_sample.png b/Sample/screenshots/run_sample.png new file mode 100644 index 0000000..55f78be Binary files /dev/null and b/Sample/screenshots/run_sample.png differ diff --git a/Sample/screenshots/sample_screenshot.png b/Sample/screenshots/sample_screenshot.png new file mode 100644 index 0000000..08836e9 Binary files /dev/null and b/Sample/screenshots/sample_screenshot.png differ diff --git a/Sample/screenshots/screenshots.png b/Sample/screenshots/screenshots.png new file mode 100644 index 0000000..620e3d6 Binary files /dev/null and b/Sample/screenshots/screenshots.png differ