Skip to content

Commit

Permalink
Update Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
melonamin committed Feb 6, 2022
1 parent faeb0d1 commit 620e535
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 14 deletions.
37 changes: 23 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ TRex lives in the menu bar and available right where you need it the most:
![TRex](Resources/screenshot.png)

To use TRex:
1. Invoke "Capture Text" either through the menu bar or with a global configurable shortcut
1. Select an area of the screen you want to extract text from, just like taking a screenshot
1. There is no third step - **extracted text is in your clipboard**
1. Invoke "Capture" either through the menu bar or with a global configurable shortcut
2. Select an area of the screen you want to extract text from, just like taking a screenshot
3. There is no third step - **extracted text is in your clipboard**

Demo:

Expand All @@ -35,42 +35,51 @@ TRex can help you to copy text from:
If you can see it on your screen - TRex can copy it.

## How to get TRex
### App Store
Buy TRex from the [App Store](https://apps.apple.com/us/app/trex-easy-ocr/id1554515538)

### GitHub
Download from [GitHub Releases](https://github.com/amebalabs/TRex/releases)
Download from [GitHub Releases](https://github.com/amebalabs/TRex/releases/latest)

### Homebrew
or Install with Homebrew
Install from Homebrew

```
brew install melonamin/formulae/trex
```
### App Store
or if you want to support us buy it from the [App Store](https://apps.apple.com/us/app/trex-easy-ocr/id1554515538)

Runs on macOS Big Sur (11.0) and up.

## ...or build it from source
- Clone or download a copy of this repository
- Open `TRex/TRex.xcodeproj`
- Press play

## Features

Every feature in TRex works offline, no internet is needed.

- Text recognition (OCR)
- Read QR Code and barcodes
- Read QR Codes and barcodes
- Handy macOS menu bar app, with option to hide it
- Configurable global shortcuts
- Configurable recognition language
- Custom words list
- CLI tool `/Applications/TRex.app/Contents/MacOS/cli/trex`
- Automation actions
- Run a Shortcut from Shortcuts.app
- Open URLs found in QR codes
- Detect and open URLs found in captured text
- Trigger a user defined URL scheme (for integration with other apps)
- URL scheme support
- `trex://capture` trigger capture
- `trex://capture` trigger capture from screen
- `trex://captureclipboard` trigger capture from clipboard
- `trex://captureautomation` trigger screen capture and run automation
- `trex://captureclipboardautomation` trigger capture from clipboard and run automation
- `trex://shortcut?name=` set Shortcut assigned to "Run Shortcut" automation action
- `trex://showPreferences` open app preferences

## Integrations

Official Alfred workflow

![TRex](Resources/alfred.png)

## Acknowledgements

Portions of this software utilize the following copyrighted material, the use of which is hereby acknowledged:
Expand Down
Binary file added Resources/TRex.alfredworkflow
Binary file not shown.
Binary file added Resources/alfred.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified Resources/screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 620e535

Please sign in to comment.