Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
AnthoPakPak committed Jan 8, 2019
1 parent d32bb66 commit f520eb5
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@

# FastFinder

[![Join the chat at https://gitter.im/AnthoPakPak-FastFinder/community](https://badges.gitter.im/AnthoPakPak-FastFinder/community.svg)](https://gitter.im/AnthoPakPak-FastFinder/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
Expand All @@ -13,7 +14,7 @@ FastFinder goal is to always have a Finder window at a key press. Set your prefe

<img src="https://i.imgur.com/rrAeThK.png" width="500">

- Download the [last version of FastFinder](https://github.com/AnthoPakPak/FastFinder/releases/download/0.1/FastFinder_v0.1.dmg)
- Download the [last version of FastFinder](https://github.com/AnthoPakPak/FastFinder/releases/download/0.1.1/FastFinder_v0.1.1.dmg)
- Drag it into your Applications folder
- Launch it and set your shortcut and settings
- If you are working with multiple Spaces, right click on Finder dock icon > `Options` > tick `All desktops` (I was unable to set it automatically currently, due to MacOS restrictions)
Expand All @@ -23,6 +24,17 @@ FastFinder goal is to always have a Finder window at a key press. Set your prefe

FastFinder is written in `Objective-C` and is a standalone app. It listens for shortcut to bring your Finder. When you trigger the shortcut, it will find your Finder window and bring it to the front. It saves this Finder window `id` in order to always present the same window, even if you have multiple Finder windows opened. Basically, if Finder is not on screen, it shows it, and if it is, it hides it.


## Changelog

- **0.1.1**
**Support for multiple tabs in Finder window** : the last opened tab in your main Finder window will be reopened. Since `AppleScript` doesn't provide informations regarding if the window is a tab part of a window or if it's a main window (everything is a window), I've made the choice to detect if it's a tab by comparing window bounds. It works well, but it may be improved.
**Temporarily disable Launch At Startup feature** : disabled this setting and explained how to do it manually, since it is inexplicably long to implement in a Cocoa app. If you have time, feel free to submit a PR with the feature ;) (here is a good link to start with https://theswiftdev.com/2017/10/27/how-to-launch-a-macos-app-at-login/).

- **0.1**
Initial release


## Limitations

In order to comply with SIP protection, FastFinder is working with `AppleScript` only (`ScriptingBridge` to be precise). This means that it doesn't inject any code into Finder. Therefore, the capabilities of FastFinder are quite limited.
Expand All @@ -31,6 +43,7 @@ The sliding animation is experimental and you can see some quick glitches in som

Also note that it won't work on fullscreen Spaces, as it will switch to an non-fullscreen Space.


## Contribution

If you find better ways to implement this, or find workarounds to fix animations glitches, please feel free to make a PR or add a new issue with your code if you're lazy for the PR ;)
Expand Down

0 comments on commit f520eb5

Please sign in to comment.