docs: rewrite README with accurate content and examples

README.md

@@ -1,44 +1,71 @@
 # SlidableImage
-![iOS CI](https://github.com/quver/SlidableImage/workflows/iOS%20CI/badge.svg)
-[![GitHub license](https://img.shields.io/github/license/quver/SlidableImage.svg)]()
+
+[![CI](https://github.com/quver/SlidableImage/actions/workflows/ci.yml/badge.svg)](https://github.com/quver/SlidableImage/actions/workflows/ci.yml)
+[![GitHub license](https://img.shields.io/github/license/quver/SlidableImage.svg)](https://github.com/quver/SlidableImage/blob/main/LICENSE)
 [![Swift Package Manager compatible](https://img.shields.io/badge/SPM-compatible-brightgreen.svg)](https://swift.org/package-manager)
+[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fquver%2FSlidableImage%2Fbadge%3Ftype%3Dswift-versions)](https://swiftpackageindex.com/quver/SlidableImage)
+[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fquver%2FSlidableImage%2Fbadge%3Ftype%3Dplatforms)](https://swiftpackageindex.com/quver/SlidableImage)
 
-Easy to use library for before & after images. One-line initialization and SwiftUI.
+SwiftUI before & after image slider with a draggable divider.
 
 ## Requirements
 
-- iOS 15
-- Swift 5
+- iOS 15+ / macOS 12+
+- Swift 6.1+
+- Xcode 16.4+
 
-## Instalation
+## Installation
 
-This library support
+### Swift Package Manager
 
-- Swift Package Manager
+Add to your `Package.swift`:
 
-## Using
+```swift
+dependencies: [
+    .package(url: "https://github.com/quver/SlidableImage.git", from: "5.0.0")
+]
+```
 
-![Code example](Assets/code.png)
+Or add it directly in Xcode via **File → Add Package Dependencies**.
 
-### Constructor 
+## Usage
 
-```swfit 
-init(@ViewBuilder arrows: @escaping () -> ArrowsIcon,
-     @ViewBuilder leftView: @escaping () -> LeftView,
-     @ViewBuilder rightView: @escaping () -> RightView)
+```swift
+SlidableImage(
+    arrows: { Arrows() },
+    leftView: { Image("before") },
+    rightView: { Image("after") }
+)
 ```
 
-### Arrows
+### Custom arrows
 
 ```swift
-init(arrowColor: Color = .white, backgroundColor: Color = .gray)
+SlidableImage(
+    arrows: {
+        Arrows(arrowColor: .black, backgroundColor: .white)
+    },
+    leftView: { Image("before") },
+    rightView: { Image("after") }
+)
 ```
 
-## Author
+### Custom divider
 
-Paweł Bednorz, Quver
+Pass any SwiftUI view as the `arrows` parameter:
+
+```swift
+SlidableImage(
+    arrows: {
+        Image(systemName: "arrow.left.and.right")
+            .padding()
+            .background(.ultraThinMaterial, in: Circle())
+    },
+    leftView: { Image("before") },
+    rightView: { Image("after") }
+)
+```
 
-## License
+## Documentation
 
-SlidableImage Lib and Slider graphic are available under the MIT license. 
-Check the LICENSE file for more information.
+Full API documentation is available at [quver.github.io/SlidableImage](https://quver.github.io/SlidableImage/documentation/slidableimage/).