doc: updates documentation on enum

manasv · Jun 30, 2022 · 62f7707 · 62f7707
1 parent 768d7a5
commit 62f7707
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -30,6 +30,8 @@ Updeto.shared.isAppUpdated { result in
         // Do something 
     case .noResults:
         // Do something
+    case .developmentOrBeta:
+        // Do something
     }
 }
 ```

diff --git a/Sources/Updeto/Updeto.swift b/Sources/Updeto/Updeto.swift
@@ -231,9 +231,15 @@ struct AppStoreLookup: Decodable {
 // MARK: - AppstoreLookupResult
 
 public enum AppStoreLookupResult: Equatable {
+    /// State that means the app is currently updated
     case updated
+    /// State that means the app is currently outdated
     case outdated
+    /// State that means installed version is higher than latest on AppStore.
+    /// This is possible if the installed version is a development / beta build (eg. Xcode, Testflight).
+    /// Worst case scenario is that the response from apple is outdated, which is unlikely to happen.
     case developmentOrBeta
+    /// State that means that the bundleId query returned no results
     case noResults
 
     /// Lookup Result description.