Add documentation

README.md

@@ -4,8 +4,12 @@
 
 A SwiftUI onChange and task view modifiers with additional debounce time.
 
+[Documentation](https://swiftpackageindex.com/Tunous/DebouncedOnChange/main/documentation/debouncedonchange)
+
 ## Usage
 
+### Basics
+
 ```swift
 import SwiftUI
 import DebouncedOnChange
@@ -23,7 +27,32 @@ struct ExampleView: View {
             }
     }
 }
-``` 
+```
+
+### Manually cancelling debounced actions
+
+```swift
+struct Sample: View {
+    @State private var debouncer = Debouncer() // 1. Store debouncer to control actions
+    @State private var query = ""
+
+    var body: some View {
+        TextField("Query", text: $query)
+            .onChange(of: query, debounceTime: .seconds(1), debouncer: $debouncer) { // 2. Pass debouncer to onChange
+                callApi()
+            }
+            .onKeyPress(.return) {
+                debouncer.cancel() // 3. Call cancel to prevent debounced action from running
+                callApi()
+                return .handled
+            }
+    }
+
+    private func callApi() {
+        print("Sending query \(query)")
+    }
+}
+```
 
 ## Installation
 

Sources/DebouncedOnChange/Debouncer.swift

@@ -44,7 +44,7 @@ import Foundation
 /// ```
 public struct Debouncer {
     var task: Task<Void, Never>?
-    
+
     /// Creates a new debouncer.
     public init() {}
 

Sources/DebouncedOnChange/Documentation.docc/Documentation.md

@@ -0,0 +1,20 @@
+# ``DebouncedOnChange``
+
+A SwiftUI onChange and task view modifiers with additional debounce time.
+
+## Topics
+
+### View extensions
+
+- ``SwiftUICore/View/onChange(of:initial:debounceTime:debouncer:_:)-9kwdz``
+- ``SwiftUICore/View/onChange(of:initial:debounceTime:debouncer:_:)-113nr``
+- ``SwiftUICore/View/task(id:priority:debounceTime:_:)``
+
+### Cancelling actions
+
+- ``Debouncer``
+
+### Depreciated View extensions
+
+- ``SwiftUICore/View/onChange(of:debounceTime:debouncer:perform:)-89k8t``
+- ``SwiftUICore/View/onChange(of:debounceTime:debouncer:perform:)-2p8uc``