You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: Sources/StreamChatSwiftUI/README.md
+5-39Lines changed: 5 additions & 39 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,16 +11,16 @@ The SwiftUI SDK offers three types of components:
11
11
12
12
- Screens - Easiest to integrate, but offer small customizations, like branding and text changes.
13
13
- Stateful components - Offer more customization options and possibility to inject custom views. Also fairly simple to integrate, if the extension points are suitable for your chat use-case. These components come with view models.
14
-
- Stateless components - These are the building blocks for the other two types of components. In order to use them, you would have to provide the state and data. Using these components only make sense if you want to implement completely custom chat experience.
14
+
- Stateless components - These are the building blocks for the other two types of components. In order to use them, you would have to provide the state and data. Using these components only make sense if you want to implement completely custom chat experience.
15
15
16
-
### Dependencies
16
+
### Dependencies
17
17
18
18
This SDK tries to keep the list of external dependencies to a minimum, these are the dependencies currently used:
19
19
20
20
#### StreamChatSwiftUI
21
21
22
22
-[Nuke](https://github.com/kean/Nuke) for loading images
23
-
-[NukeUI](https://github.com/kean/NukeUI) for SwiftUI async image loading
23
+
-[NukeUI](https://github.com/kean/NukeUI) for SwiftUI async image loading
24
24
-[SwiftyGif](https://github.com/kirualex/SwiftyGif) for high performance GIF rendering
25
25
- StreamChat the low-level client to Stream Chat API
26
26
@@ -50,41 +50,7 @@ The repository contains 3 targets: StreamChat, StreamChatUI and StreamChatSwiftU
50
50
After you press finish, it's done!
51
51
52
52
:::caution
53
-
Because StreamChat SDKs have to be distributed with its resources, the minimal Swift version requirement for this installation method is 5.3. If you need to support older Swift version, please install it using CocoaPods.
53
+
Because StreamChat SDKs have to be distributed with its resources, the minimal Swift version requirement for this installation method is 5.3.
54
54
:::
55
55
56
-
### Install with CocoaPods
57
-
58
-
In your project's Podfile, add: `pod 'StreamChatSwiftUI', '~> 0.0.1'`. It should look similar to the snippet below.
59
-
60
-
```ruby
61
-
target 'MyProject'do
62
-
# Comment the next line if you don't want to use dynamic frameworks
63
-
use_frameworks!
64
-
65
-
# Pods for MyProject
66
-
pod 'StreamChatSwiftUI', '~> 0.0.1'
67
-
end
68
-
```
69
-
70
-
The StreamChatUI pod will automatically include the StreamChat dependency. If you want just the StreamChat dependency, without the UI components, add `pod 'StreamChat', '~> 4.0'` to your Podfile instead. It should look similar to the snippet below.
71
-
72
-
```ruby
73
-
target 'MyProject'do
74
-
# Comment the next line if you don't want to use dynamic frameworks
75
-
use_frameworks!
76
-
77
-
# Pods for MyProject
78
-
pod 'StreamChat', '~> 4.0.0'
79
-
end
80
-
```
81
-
82
-
Now that we’ve modified our Podfile, let’s go ahead and install the project dependencies via the terminal with one simple command:
83
-
84
-
```bash
85
-
pod install --repo-update
86
-
```
87
-
88
-
The above command will generate the **MyProject.xcworkspace** file automatically.
89
-
90
-
To stay up-to-date with our updates and get a detailed breakdown of what's new, subscribe to the releases of [getstream/stream-chat-swift](https://github.com/GetStream/stream-chat-swift/releases) by clicking the "watch" button. You can further tweak your watch preferences and subscribe only to the release events.
56
+
To stay up-to-date with our updates and get a detailed breakdown of what's new, subscribe to the releases of [getstream/stream-chat-swift](https://github.com/GetStream/stream-chat-swift/releases) by clicking the "watch" button. You can further tweak your watch preferences and subscribe only to the release events.
0 commit comments