Skip to content
Merged
Changes from all commits
Commits
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
25 changes: 24 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ ETDistribution is a Swift library that simplifies the process of distributing ne
To integrate ETDistribution into your project, add the following line to your Package.swift:
```swift
dependencies: [
.package(url: "https://github.com/EmergeTools/ETDistribution.git", from: "v0.1.0")
.package(url: "https://github.com/EmergeTools/ETDistribution.git", from: "v0.1.2")
]
```

Expand Down Expand Up @@ -87,6 +87,10 @@ An API key is required to authenticate requests. You can obtain your API key fro

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.

### Login Level

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.

### Handling Responses

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.
Expand All @@ -104,6 +108,25 @@ For more detailed documentation and additional examples, visit our [Documentatio

The library is designed to skip update checks on the simulator. To test update functionality, run your app on a physical device.

### Why I am not getting any update?

There could be several reasons:
- Update checks are disabled for both Simulators and Debug builds.
- 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.

### How do I skip an update?

When handling the response you can check the release version field to decide if it should be installed or not.

### Can I use ETDistribution to get updates from the AppStore?

No, since the binary signer is different (builds installed from the AppStore are signed by Apple), the update will fail.

### Can I require login to get updates?

Yes, there are 3 options for security:
- No login required.
- Login required only for downloading the update (can check for updates without login).
- Login required for checking for updates.

These options can be configured per platform at [Emerge Tools Settings](https://www.emergetools.com/settings?tab=feature-configuration).