Merge pull request #62 from SentulAsia/master

Update docs
zaidmsaid · Jul 15, 2019 · 2eb726b · 2eb726b
2 parents ca406cd + f8b140e
commit 2eb726b
Show file tree

Hide file tree

Showing 22 changed files with 555 additions and 53 deletions.
diff --git a/DataStoreManager.podspec b/DataStoreManager.podspec
@@ -16,7 +16,7 @@ Pod::Spec.new do |s|
   #
 
   s.name         = "DataStoreManager"
-  s.version      = "0.9.2"
+  s.version      = "0.9.3"
   s.summary      = "This library allows you to easily manage persistent data in your iOS app."
 
   # This description is used to generate tags and improve search results.

diff --git a/DataStoreManager.xcodeproj/DataStoreManager_Info.plist b/DataStoreManager.xcodeproj/DataStoreManager_Info.plist
@@ -15,7 +15,7 @@
 	<key>CFBundlePackageType</key>
 	<string>FMWK</string>
 	<key>CFBundleShortVersionString</key>
-	<string>0.9.2</string>
+	<string>0.9.3</string>
 	<key>CFBundleSignature</key>
 	<string>????</string>
 	<key>CFBundleVersion</key>

diff --git a/README.md b/README.md
@@ -151,7 +151,7 @@ for up to date installation instructions.
 
 [carthage-installation]: https://github.com/Carthage/Carthage#adding-frameworks-to-an-application
 
-#### <img src="https://raw.githubusercontent.com/zaidmsaid/DataStoreManager/master/resources/cocoapods.png" width="24" height="24"> [CocoaPods]
+#### <img src="https://raw.githubusercontent.com/zaidmsaid/DataStoreManager/master/Resources/cocoapods.png" width="24" height="24"> [CocoaPods]
 
 [CocoaPods]: http://cocoapods.org
 
@@ -169,23 +169,23 @@ use_frameworks!
 
 Then run `pod install` with CocoaPods 1.6.0 or newer.
 
-#### <img src="https://raw.githubusercontent.com/zaidmsaid/DataStoreManager/master/resources/swift.png" width="24" height="24"> [Swift Package Manager]
+#### <img src="https://raw.githubusercontent.com/zaidmsaid/DataStoreManager/master/Resources/swift.png" width="24" height="24"> [Swift Package Manager]
 
 [Swift Package Manager]: https://swift.org/package-manager/
 
 To install it, simply add the following line to your **Package.swift**:
 
 ```swift
 dependencies: [
-    .package(url: "https://github.com/zaidmsaid/DataStoreManager.git", .upToNextMinor(from: "0.9.2"))
+    .package(url: "https://github.com/zaidmsaid/DataStoreManager.git", .upToNextMinor(from: "0.9.3"))
 ]
 ```
 
 or more strict:
 
 ```swift
 dependencies: [
-    .package(url: "https://github.com/zaidmsaid/DataStoreManager.git", .exact("0.9.2"))
+    .package(url: "https://github.com/zaidmsaid/DataStoreManager.git", .exact("0.9.3"))
 ]
 ```
 

diff --git a/Sources/DataStoreManager/CloudKitWorker.swift b/Sources/DataStoreManager/CloudKitWorker.swift
@@ -16,11 +16,11 @@
 
 import CloudKit
 
-// MARK: - CKContainer
+// MARK: - CloudKit
 
 extension DataStoreManager {
 
-    /// An interface to the CKContainer.
+    /// An interface to the CloudKit.
     @available(watchOSApplicationExtension 3.0, *)
     class CloudKitWorker {
 

diff --git a/Sources/DataStoreManager/DataStoreManager.swift b/Sources/DataStoreManager/DataStoreManager.swift
@@ -118,7 +118,7 @@ import Foundation
         return worker
     }()
 
-    /// An interface to the CKContainer.
+    /// An interface to the CloudKit.
     @available(watchOSApplicationExtension 3.0, *)
     lazy var cloudKitWorker: CloudKitWorker = {
         let worker = CloudKitWorker()

diff --git a/Sources/DataStoreManager/Models/StorageType.swift b/Sources/DataStoreManager/Models/StorageType.swift
@@ -120,22 +120,22 @@ extension DataStoreStorageType : RawRepresentable {
     public static let coreData = DataStoreStorageType("CoreData")
 
     /// The storage type
-    /// [CKContainer](apple-reference-documentation://hsS7IJpn_8)
+    /// [CloudKit](https://developer.apple.com/documentation/cloudkit)
     /// with
     /// [privateCloudDatabase](apple-reference-documentation://hsl8OIqKuV).
-    public static let privateCloudDatabase = DataStoreStorageType("CKContainer.privateCloudDatabase")
+    public static let privateCloudDatabase = DataStoreStorageType("CloudKit.privateCloudDatabase")
 
     /// The storage type
-    /// [CKContainer](apple-reference-documentation://hsS7IJpn_8)
+    /// [CloudKit](https://developer.apple.com/documentation/cloudkit)
     /// with
     /// [publicCloudDatabase](apple-reference-documentation://hsr3N4H2SH).
-    public static let publicCloudDatabase = DataStoreStorageType("CKContainer.publicCloudDatabase")
+    public static let publicCloudDatabase = DataStoreStorageType("CloudKit.publicCloudDatabase")
 
     /// The storage type
-    /// [CKContainer](apple-reference-documentation://hsS7IJpn_8)
+    /// [CloudKit](https://developer.apple.com/documentation/cloudkit)
     /// with
     /// [sharedCloudDatabase](apple-reference-documentation://hse91QSrM6).
-    public static let sharedCloudDatabase = DataStoreStorageType("CKContainer.sharedCloudDatabase")
+    public static let sharedCloudDatabase = DataStoreStorageType("CloudKit.sharedCloudDatabase")
 
     /// The storage type
     /// [NSUbiquitousKeyValueStore](apple-reference-documentation://hskNNwzU6H).
@@ -215,13 +215,13 @@ extension DataStoreStorageType {
             return "CoreData"
 
         case .privateCloudDatabase:
-            return "CKContainer"
+            return "CloudKit"
 
         case .publicCloudDatabase:
-            return "CKContainer"
+            return "CloudKit"
 
         case .sharedCloudDatabase:
-            return "CKContainer"
+            return "CloudKit"
 
         case .ubiquitousCloudStore:
             return "NSUbiquitousKeyValueStore"
@@ -274,13 +274,13 @@ extension DataStoreStorageType {
             return "CoreData"
 
         case .privateCloudDatabase:
-            return "CKContainer"
+            return "CloudKit"
 
         case .publicCloudDatabase:
-            return "CKContainer"
+            return "CloudKit"
 
         case .sharedCloudDatabase:
-            return "CKContainer"
+            return "CloudKit"
 
         case .ubiquitousCloudStore:
             return "NSUbiquitousKeyValueStore"

diff --git a/Sources/DataStoreManager/Protocols/DataSource.swift b/Sources/DataStoreManager/Protocols/DataSource.swift
@@ -252,12 +252,12 @@ import CloudKit
 
     // MARK: Cloud Kit Container
 
-    /// Asks the data source for the containerIdentifier for `CKContainer`
+    /// Asks the data source for the containerIdentifier for `CloudKit`
     /// of the data store manager.
     ///
     /// - Parameter manager: An object representing the data store manager
     ///                      requesting this information.
-    /// - Returns: The `CKContainer` containerIdentifier for the data store
+    /// - Returns: The `CloudKit` containerIdentifier for the data store
     ///            manager.
     @objc optional func cloudKitContainerIdentifier(for manager: DataStoreManager) -> String
 

diff --git a/docs/Classes/DataStoreManager.html b/docs/Classes/DataStoreManager.html
@@ -504,7 +504,7 @@ <h4>Declaration</h4>
                     <section class="section">
                       <div class="pointer"></div>
                       <div class="abstract">
-                        <p>An interface to the CKContainer.</p>
+                        <p>An interface to the CloudKit.</p>
 
                       </div>
                       <div class="declaration">
@@ -1899,10 +1899,10 @@ <h4>Declaration</h4>
             </div>
             <div class="task-group">
               <div class="task-name-container">
-                <a name="/CKContainer"></a>
-                <a name="//apple_ref/swift/Section/CKContainer" class="dashAnchor"></a>
-                <a href="#/CKContainer">
-                  <h3 class="section-name">CKContainer</h3>
+                <a name="/CloudKit"></a>
+                <a name="//apple_ref/swift/Section/CloudKit" class="dashAnchor"></a>
+                <a href="#/CloudKit">
+                  <h3 class="section-name">CloudKit</h3>
                 </a>
               </div>
               <ul>
@@ -1919,7 +1919,7 @@ <h3 class="section-name">CKContainer</h3>
                     <section class="section">
                       <div class="pointer"></div>
                       <div class="abstract">
-                        <p>An interface to the CKContainer.</p>
+                        <p>An interface to the CloudKit.</p>
 
                         <a href="../Classes/DataStoreManager/CloudKitWorker.html" class="slightly-smaller">See more</a>
                       </div>

diff --git a/docs/Classes/DataStoreManager/CloudKitWorker.html b/docs/Classes/DataStoreManager/CloudKitWorker.html
@@ -128,7 +128,7 @@ <h1>CloudKitWorker</h1>
 
                 </div>
               </div>
-            <p>An interface to the CKContainer.</p>
+            <p>An interface to the CloudKit.</p>
 
           </section>
           <section class="section task-group-section">

diff --git a/docs/Classes/DataStoreStorageType.html b/docs/Classes/DataStoreStorageType.html
@@ -621,7 +621,7 @@ <h4>Declaration</h4>
                       <div class="pointer"></div>
                       <div class="abstract">
                         <p>The storage type
-<a href="apple-reference-documentation://hsS7IJpn_8">CKContainer</a>
+<a href="https://developer.apple.com/documentation/cloudkit">CloudKit</a>
 with
 <a href="apple-reference-documentation://hsl8OIqKuV">privateCloudDatabase</a>.</p>
 
@@ -651,7 +651,7 @@ <h4>Declaration</h4>
                       <div class="pointer"></div>
                       <div class="abstract">
                         <p>The storage type
-<a href="apple-reference-documentation://hsS7IJpn_8">CKContainer</a>
+<a href="https://developer.apple.com/documentation/cloudkit">CloudKit</a>
 with
 <a href="apple-reference-documentation://hsr3N4H2SH">publicCloudDatabase</a>.</p>
 
@@ -681,7 +681,7 @@ <h4>Declaration</h4>
                       <div class="pointer"></div>
                       <div class="abstract">
                         <p>The storage type
-<a href="apple-reference-documentation://hsS7IJpn_8">CKContainer</a>
+<a href="https://developer.apple.com/documentation/cloudkit">CloudKit</a>
 with
 <a href="apple-reference-documentation://hse91QSrM6">sharedCloudDatabase</a>.</p>
 

diff --git a/docs/Protocols/DataStoreManagerDataSource.html b/docs/Protocols/DataStoreManagerDataSource.html
@@ -1097,7 +1097,7 @@ <h3 class="section-name">Cloud Kit Container</h3>
                     <section class="section">
                       <div class="pointer"></div>
                       <div class="abstract">
-                        <p>Asks the data source for the containerIdentifier for <code>CKContainer</code>
+                        <p>Asks the data source for the containerIdentifier for <code>CloudKit</code>
 of the data store manager.</p>
 
                       </div>
@@ -1132,7 +1132,7 @@ <h4>Parameters</h4>
                       </div>
                       <div>
                         <h4>Return Value</h4>
-                        <p>The <code>CKContainer</code> containerIdentifier for the data store
+                        <p>The <code>CloudKit</code> containerIdentifier for the data store
        manager.</p>
                       </div>
                     </section>

diff --git a/...ocsets/DataStoreManager.docset/Contents/Resources/Documents/Classes/DataStoreManager.html b/...ocsets/DataStoreManager.docset/Contents/Resources/Documents/Classes/DataStoreManager.html
@@ -504,7 +504,7 @@ <h4>Declaration</h4>
                     <section class="section">
                       <div class="pointer"></div>
                       <div class="abstract">
-                        <p>An interface to the CKContainer.</p>
+                        <p>An interface to the CloudKit.</p>
 
                       </div>
                       <div class="declaration">
@@ -1899,10 +1899,10 @@ <h4>Declaration</h4>
             </div>
             <div class="task-group">
               <div class="task-name-container">
-                <a name="/CKContainer"></a>
-                <a name="//apple_ref/swift/Section/CKContainer" class="dashAnchor"></a>
-                <a href="#/CKContainer">
-                  <h3 class="section-name">CKContainer</h3>
+                <a name="/CloudKit"></a>
+                <a name="//apple_ref/swift/Section/CloudKit" class="dashAnchor"></a>
+                <a href="#/CloudKit">
+                  <h3 class="section-name">CloudKit</h3>
                 </a>
               </div>
               <ul>
@@ -1919,7 +1919,7 @@ <h3 class="section-name">CKContainer</h3>
                     <section class="section">
                       <div class="pointer"></div>
                       <div class="abstract">
-                        <p>An interface to the CKContainer.</p>
+                        <p>An interface to the CloudKit.</p>
 
                         <a href="../Classes/DataStoreManager/CloudKitWorker.html" class="slightly-smaller">See more</a>
                       </div>

diff --git a/...eManager.docset/Contents/Resources/Documents/Classes/DataStoreManager/CloudKitWorker.html b/...eManager.docset/Contents/Resources/Documents/Classes/DataStoreManager/CloudKitWorker.html
@@ -128,7 +128,7 @@ <h1>CloudKitWorker</h1>
 
                 </div>
               </div>
-            <p>An interface to the CKContainer.</p>
+            <p>An interface to the CloudKit.</p>
 
           </section>
           <section class="section task-group-section">

diff --git a/...ts/DataStoreManager.docset/Contents/Resources/Documents/Classes/DataStoreStorageType.html b/...ts/DataStoreManager.docset/Contents/Resources/Documents/Classes/DataStoreStorageType.html
@@ -621,7 +621,7 @@ <h4>Declaration</h4>
                       <div class="pointer"></div>
                       <div class="abstract">
                         <p>The storage type
-<a href="apple-reference-documentation://hsS7IJpn_8">CKContainer</a>
+<a href="https://developer.apple.com/documentation/cloudkit">CloudKit</a>
 with
 <a href="apple-reference-documentation://hsl8OIqKuV">privateCloudDatabase</a>.</p>
 
@@ -651,7 +651,7 @@ <h4>Declaration</h4>
                       <div class="pointer"></div>
                       <div class="abstract">
                         <p>The storage type
-<a href="apple-reference-documentation://hsS7IJpn_8">CKContainer</a>
+<a href="https://developer.apple.com/documentation/cloudkit">CloudKit</a>
 with
 <a href="apple-reference-documentation://hsr3N4H2SH">publicCloudDatabase</a>.</p>
 
@@ -681,7 +681,7 @@ <h4>Declaration</h4>
                       <div class="pointer"></div>
                       <div class="abstract">
                         <p>The storage type
-<a href="apple-reference-documentation://hsS7IJpn_8">CKContainer</a>
+<a href="https://developer.apple.com/documentation/cloudkit">CloudKit</a>
 with
 <a href="apple-reference-documentation://hse91QSrM6">sharedCloudDatabase</a>.</p>
 

diff --git a/...toreManager.docset/Contents/Resources/Documents/Protocols/DataStoreManagerDataSource.html b/...toreManager.docset/Contents/Resources/Documents/Protocols/DataStoreManagerDataSource.html
@@ -1097,7 +1097,7 @@ <h3 class="section-name">Cloud Kit Container</h3>
                     <section class="section">
                       <div class="pointer"></div>
                       <div class="abstract">
-                        <p>Asks the data source for the containerIdentifier for <code>CKContainer</code>
+                        <p>Asks the data source for the containerIdentifier for <code>CloudKit</code>
 of the data store manager.</p>
 
                       </div>
@@ -1132,7 +1132,7 @@ <h4>Parameters</h4>
                       </div>
                       <div>
                         <h4>Return Value</h4>
-                        <p>The <code>CKContainer</code> containerIdentifier for the data store
+                        <p>The <code>CloudKit</code> containerIdentifier for the data store
        manager.</p>
                       </div>
                     </section>

diff --git a/docs/docsets/DataStoreManager.docset/Contents/Resources/Documents/badge.svg b/docs/docsets/DataStoreManager.docset/Contents/Resources/Documents/badge.svg
diff --git a/docs/docsets/DataStoreManager.docset/Contents/Resources/Documents/index.html b/docs/docsets/DataStoreManager.docset/Contents/Resources/Documents/index.html
@@ -275,13 +275,13 @@ <h4 id='img-src-https-raw-githubusercontent-com-zaidmsaid-datastoremanager-maste
 
 <p>To install it, simply add the following line to your <strong>Package.swift</strong>:</p>
 <pre class="highlight swift"><code><span class="nv">dependencies</span><span class="p">:</span> <span class="p">[</span>
-    <span class="o">.</span><span class="nf">package</span><span class="p">(</span><span class="nv">url</span><span class="p">:</span> <span class="s">"https://github.com/zaidmsaid/DataStoreManager.git"</span><span class="p">,</span> <span class="o">.</span><span class="nf">upToNextMinor</span><span class="p">(</span><span class="nv">from</span><span class="p">:</span> <span class="s">"0.9.2"</span><span class="p">))</span>
+    <span class="o">.</span><span class="nf">package</span><span class="p">(</span><span class="nv">url</span><span class="p">:</span> <span class="s">"https://github.com/zaidmsaid/DataStoreManager.git"</span><span class="p">,</span> <span class="o">.</span><span class="nf">upToNextMinor</span><span class="p">(</span><span class="nv">from</span><span class="p">:</span> <span class="s">"0.9.3"</span><span class="p">))</span>
 <span class="p">]</span>
 </code></pre>
 
 <p>or more strict:</p>
 <pre class="highlight swift"><code><span class="nv">dependencies</span><span class="p">:</span> <span class="p">[</span>
-    <span class="o">.</span><span class="nf">package</span><span class="p">(</span><span class="nv">url</span><span class="p">:</span> <span class="s">"https://github.com/zaidmsaid/DataStoreManager.git"</span><span class="p">,</span> <span class="o">.</span><span class="nf">exact</span><span class="p">(</span><span class="s">"0.9.2"</span><span class="p">))</span>
+    <span class="o">.</span><span class="nf">package</span><span class="p">(</span><span class="nv">url</span><span class="p">:</span> <span class="s">"https://github.com/zaidmsaid/DataStoreManager.git"</span><span class="p">,</span> <span class="o">.</span><span class="nf">exact</span><span class="p">(</span><span class="s">"0.9.3"</span><span class="p">))</span>
 <span class="p">]</span>
 </code></pre>
 

diff --git a/docs/docsets/DataStoreManager.docset/Contents/Resources/Documents/search.json b/docs/docsets/DataStoreManager.docset/Contents/Resources/Documents/search.json