Skip to content

Commit

Permalink
[Documentation] Add usage part in README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Kyle-Ye committed Feb 18, 2025
1 parent a3b482c commit 110c298
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,22 @@ Then add the dependency to any targets you've declared in your manifest:
),
```

## Usage

Instead of wrapping your view in a secure UITextField or [ScreenShieldView](https://github.com/RyukieSama/Swifty),

you can just directly call the `hideFromCapture(hidden:)` API on your view or layer.

```swift
import ScreenShieldKit

let view = UIView(frame: .zero)
view.hideFromCapture(hidden: true)

// Resture the behavior
view.hideFromCapture(hidden: false)
```

## License

See LICENSE file - MIT
Expand Down

0 comments on commit 110c298

Please sign in to comment.