-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
23 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,30 +1,41 @@ | ||
![Generic badge](https://github.com/konoui/alfred-tldr/workflows/test/badge.svg) | ||
|
||
## alfred tldr | ||
[tldr](https://github.com/tldr-pages/tldr) alfred workflow written in go. | ||
|
||
[tldr-pages](https://github.com/tldr-pages/tldr) alfred workflow written in go. | ||
|
||
![alfred-tldr](./alfred-tldr.gif) | ||
|
||
## Usage | ||
|
||
`tldr <query>` | ||
|
||
Options | ||
`--version`/`-v` option shows the current version of the client. | ||
`--update`/`-u` option updates local database (tldr repository). | ||
`--platform`/`-p` option selects platform from `linux`,`osx`,`sunos`,`windows`. | ||
`--language`/`-L` option selects preferred language for the page. | ||
|
||
## Install | ||
- Download and open the workflow with terminal for bypassing GateKeeper on macOS. | ||
|
||
- Download and open the workflow with terminal for macOS. | ||
|
||
``` | ||
$ curl -O -L https://github.com/konoui/alfred-tldr/releases/latest/download/tldr.alfredworkflow && open tldr.alfredworkflow | ||
``` | ||
|
||
- Build the workflow on your computer. | ||
|
||
``` | ||
$ make package | ||
$ ls | ||
tldr.alfredworkflow (snip) | ||
``` | ||
|
||
## Usage | ||
`tldr <query>` | ||
|
||
Options | ||
`--version`/`-v` option shows the current version of the client. | ||
`--update`/`-u` option updates local database (tldr repository). | ||
`--platform`/`-p` option selects platform from `linux`,`osx`,`sunos`,`windows`. | ||
`--language`/`-L` option selects preferred language for the page. | ||
![alfred-tldr](./alfred-tldr.gif) | ||
|
||
## License | ||
|
||
MIT License. | ||
|
||
## Special Thanks | ||
|
||
Icons are provided by [takafumi-max](https://github.com/takafumi-max) |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.