Skip to content

Commit

Permalink
renew icons #7 (#12)
Browse files Browse the repository at this point in the history
  • Loading branch information
konoui authored Mar 28, 2021
1 parent d74b9d5 commit 34e070d
Show file tree
Hide file tree
Showing 5 changed files with 23 additions and 12 deletions.
35 changes: 23 additions & 12 deletions README.md
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)
Binary file modified alfred-tldr.gif
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 assets/candidate.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 assets/description.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 assets/icon.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 34e070d

Please sign in to comment.