diff --git a/README.md b/README.md index 4341151..f7be5ed 100644 --- a/README.md +++ b/README.md @@ -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 ` + +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 ` - -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) diff --git a/alfred-tldr.gif b/alfred-tldr.gif index 2366a3b..01496db 100644 Binary files a/alfred-tldr.gif and b/alfred-tldr.gif differ diff --git a/assets/candidate.png b/assets/candidate.png index 99ee381..3995164 100644 Binary files a/assets/candidate.png and b/assets/candidate.png differ diff --git a/assets/description.png b/assets/description.png index c9fb155..efd7c14 100644 Binary files a/assets/description.png and b/assets/description.png differ diff --git a/assets/icon.png b/assets/icon.png index c9fb155..a234568 100644 Binary files a/assets/icon.png and b/assets/icon.png differ