Skip to content

Commit 8285260

Browse files
authored
Update readme (#13)
* Bump version * Add more FAQ questions * Improve readme
1 parent 82fe3c1 commit 8285260

File tree

1 file changed

+24
-1
lines changed

1 file changed

+24
-1
lines changed

README.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ ETDistribution is a Swift library that simplifies the process of distributing ne
2525
To integrate ETDistribution into your project, add the following line to your Package.swift:
2626
```swift
2727
dependencies: [
28-
.package(url: "https://github.com/EmergeTools/ETDistribution.git", from: "v0.1.0")
28+
.package(url: "https://github.com/EmergeTools/ETDistribution.git", from: "v0.1.2")
2929
]
3030
```
3131

@@ -87,6 +87,10 @@ An API key is required to authenticate requests. You can obtain your API key fro
8787
8888
Tags can be used to associate builds, you could use tags to represent the dev branch, an internal project or any team builds. If the same binary has been uploaded with multiple tags, you can specify a tagName to differentiate between them. This is usually not needed, as the SDK will identify the tag automatically.
8989
90+
### Login Level
91+
92+
Login levels can be configured to require login for certain actions (like downloading the update or checking for updates). They are set at [Emerge Tools Settings](https://www.emergetools.com/settings?tab=feature-configuration). You should match that level at the app level.
93+
9094
### Handling Responses
9195
9296
By default, if no completion closure is provided, the SDK will present an alert to the user, prompting them to install the release. You can customize this behavior using the closures provided by the API.
@@ -104,6 +108,25 @@ For more detailed documentation and additional examples, visit our [Documentatio
104108
105109
The library is designed to skip update checks on the simulator. To test update functionality, run your app on a physical device.
106110
111+
### Why I am not getting any update?
112+
113+
There could be several reasons:
114+
- Update checks are disabled for both Simulators and Debug builds.
115+
- ETDistribution is intended to update from an already published version on ETDistribution. If the current build has not been uploaded to Emerge Tools, you won't get any update notification.
116+
107117
### How do I skip an update?
108118
109119
When handling the response you can check the release version field to decide if it should be installed or not.
120+
121+
### Can I use ETDistribution to get updates from the AppStore?
122+
123+
No, since the binary signer is different (builds installed from the AppStore are signed by Apple), the update will fail.
124+
125+
### Can I require login to get updates?
126+
127+
Yes, there are 3 options for security:
128+
- No login required.
129+
- Login required only for downloading the update (can check for updates without login).
130+
- Login required for checking for updates.
131+
132+
These options can be configured per platform at [Emerge Tools Settings](https://www.emergetools.com/settings?tab=feature-configuration).

0 commit comments

Comments
 (0)