Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
cdzombak committed Apr 30, 2024
1 parent 2188139 commit 060739b
Showing 1 changed file with 15 additions and 10 deletions.
25 changes: 15 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,30 @@
# alfred-bear

> Allows you to quickly search for and open Bear notes from Alfred. It will search tags, note content, titles, etc. to try to bring you the best match.
Allows you to quickly search for and open Bear notes from Alfred. It will search tags, note content, titles, etc. to try to bring you the best match.

![usage example screenshot](/image.png)
![usage example screenshot](/readme.images/image.png)

## Installation

Grab the latest release [here](https://github.com/bjrnt/alfred-bear/releases/) and install the workflow file.

_Note:_ The first time you use the extension, it will be blocked from running and you will have to open "Security & Privacy" to allow it.
Download `alfred-bear-VERSION.alfredworkflow.dmg` from the [latest release](https://github.com/cdzombak/alfred-bear/releases/latest), open the downloaded `.dmg` file, and double-click the `.alfredworkflow` file to install it.

## Usage

Open Alfred and type `b` and try typing a query. You can change the search keyword or configure a hotkey for it in the workflow settings.

## Maintenance
## About

Maintained by [Chris Dzombak](https://www.dzombak.com) ([@cdzombak on GitHub](https://github.com/cdzombak)).

### Issues and Feature Requests
Originally based on [bjrnt/alfred-bear](https://github.com/bjrnt/alfred-bear).

Feel free to open an issue for the project if you have encountered a problem or have a feature request for the workflow.
Principal changes in @cdzombak's fork:
- Use [modernc.org/sqlite](https://pkg.go.dev/modernc.org/sqlite) to remove cgo dependency
- Update dependencies
- Use GitHub Actions for the build & release process
- Codesign the embedded `alfred-bear` binary for distribution outside the Mac App Store
- Notarize the workflow for distribution

### Building
## License

The project can be built, linked to Alfred, and released using [jason0x34/go-alfred](https://github.com/jason0x43/go-alfred). Commands for this can be found in [./.vscode/tasks.json](./.vscode/tasks.json).
MIT; see LICENSE in this repository.

0 comments on commit 060739b

Please sign in to comment.