Add description of useTransactionsInternally to docs (#162)

* Add description of useTransactionsInternally to docs

* More docs

* remove extra linux build from ci

* use latest version of swiftyactions

* bump SDK version in readme because of mongo transaction issue

Author: cbaker6

.github/workflows/ci.yml

@@ -97,25 +97,9 @@ jobs:
     runs-on: ubuntu-18.04
     steps:
       - uses: actions/checkout@v2
-      - uses: sersoft-gmbh/SwiftyActions@v1.1.1
+      - uses: sersoft-gmbh/SwiftyActions@v1
         with:
-          release-version: 5.3.3
-      - name: Build
-        run: swift build
-      - name: Test
-        run: swift test --enable-test-discovery --enable-code-coverage
-      - name: Prepare codecov
-        run: llvm-cov export -format="lcov" .build/x86_64-unknown-linux-gnu/debug/ParseSwiftPackageTests.xctest -instr-profile .build/x86_64-unknown-linux-gnu/debug/codecov/default.profdata > info.lcov
-      - name: Send codecov
-        run: bash <(curl https://codecov.io/bash)
-
-  linux-5_4:
-    runs-on: ubuntu-18.04
-    steps:
-      - uses: actions/checkout@v2
-      - uses: sersoft-gmbh/[email protected]
-        with:
-          release-version: 5.4
+          release-version: 5.4.1
       - name: Build
         run: swift build
       - name: Test

README.md

@@ -44,7 +44,7 @@ import PackageDescription
 let package = Package(
     name: "YOUR_PROJECT_NAME",
     dependencies: [
-        .package(url: "https://github.com/parse-community/Parse-Swift", from: "1.3.0"),
+        .package(url: "https://github.com/parse-community/Parse-Swift", from: "1.8.1"),
     ]
 )
 ```

Sources/ParseSwift/Parse.swift

@@ -45,6 +45,7 @@ public struct ParseConfiguration {
      - parameter liveQueryServerURL: The live query server URL to connect to Parse Server.
      - parameter allowCustomObjectId: Allows objectIds to be created on the client.
      side for each object. Must be enabled on the server to work.
+     - parameter useTransactionsInternally: Use transactions inside the Client SDK.
      - parameter keyValueStore: A key/value store that conforms to the `ParseKeyValueStore`
      protocol. Defaults to `nil` in which one will be created an memory, but never persisted. For Linux, this
      this is the only store available since there is no Keychain. Linux users should replace this store with an
@@ -54,6 +55,7 @@ public struct ParseConfiguration {
      It should have the following argument signature: `(challenge: URLAuthenticationChallenge,
      completionHandler: (URLSession.AuthChallengeDisposition, URLCredential?) -> Void) -> Void`.
      See Apple's [documentation](https://developer.apple.com/documentation/foundation/urlsessiontaskdelegate/1411595-urlsession) for more for details.
+     - warning: `useTransactionsInternally` is experimental and known not to work with mongoDB.
      */
     public init(applicationId: String,
                 clientKey: String? = nil,
@@ -140,6 +142,7 @@ public struct ParseSwift {
      - parameter liveQueryServerURL: The live query server URL to connect to Parse Server.
      - parameter allowCustomObjectId: Allows objectIds to be created on the client.
      side for each object. Must be enabled on the server to work.
+     - parameter useTransactionsInternally: Use transactions inside the Client SDK.
      - parameter keyValueStore: A key/value store that conforms to the `ParseKeyValueStore`
      protocol. Defaults to `nil` in which one will be created an memory, but never persisted. For Linux, this
      this is the only store available since there is no Keychain. Linux users should replace this store with an
@@ -151,6 +154,7 @@ public struct ParseSwift {
      It should have the following argument signature: `(challenge: URLAuthenticationChallenge,
      completionHandler: (URLSession.AuthChallengeDisposition, URLCredential?) -> Void) -> Void`.
      See Apple's [documentation](https://developer.apple.com/documentation/foundation/urlsessiontaskdelegate/1411595-urlsession) for more for details.
+     - warning: `useTransactionsInternally` is experimental and known not to work with mongoDB.
      */
     static public func initialize(
         applicationId: String,