Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
DivineDominion committed May 4, 2021
1 parent a0dddfe commit 703c2fc
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,12 @@
![Platform](https://img.shields.io/badge/platform-macOS-lightgrey.svg?style=flat)
[![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)

Display things in an app-modal floating window that users can fuzzy-filter by typing ahead.
Display things in an app-modal floating window that users can fuzzy-filter by typing ahead. Its style roughly matches the floating Spotlight window.

![](assets/screenshot-combined.png)

The list uses the default `NSTableView` styles, so it'll look right at home on Big Sur and older macOS versions alike!

## Usage

This module strives for taking care of its components's memory wherever possible. This means you do not need to keep a reference to the window or its controller around. **Both will be freed when the action has been completed.**
Expand All @@ -22,7 +24,7 @@ This is useful if you want to filter e.g. a limited collection of files, like "R
```swift
import FloatingFilter

// ...
// ...

let items = [
Item(identifier: UUID(), title: "Create new widget"),
Expand All @@ -45,11 +47,11 @@ Add this to your `Cartfile`:

github "cleancocoa/FloatingFilter"

Then run
Then run

$ carthage update

... and include `FloatingFilter.framework` from `Carthage/Build/Mac` in your app.
... and include `FloatingFilter.framework` from `Carthage/Build/Mac` in your app.

## License

Expand Down

0 comments on commit 703c2fc

Please sign in to comment.