Skip to content

Commit 74f0065

Browse files
author
pedro
committed
synced readme
2 parents 597d8c0 + 4d33a50 commit 74f0065

File tree

1 file changed

+21
-3
lines changed

1 file changed

+21
-3
lines changed

README.md

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ Just press `Ctrl+t` and start typing.
5858

5959
Pick the command you want by pressing enter. To abort press `Ctrl+C`
6060

61-
## A commands to your cheat sheet
61+
## Add commands to your cheat sheet
6262

6363
Commmands are stored in `~/.config/icl/commands.txt`
6464

@@ -79,11 +79,29 @@ ps aux
7979
8080
```
8181

82-
### Bonus: icl as a TLDR client
82+
## Change the keybind
8383

84-
The file tldr.txt includes all commands scrapped from tldr repository. If you want to be able to access them using icl, simply place them in your ''commands.txt''. You can do so by running the following command.
84+
If you installed `icl` with the one line snippets provided above. The keybind is defined in `~/.config/fish/config.fish` , `~/.bashrc` or `~/.zshrc` depending on which shell you are using. Look for one of the following commands and replace `ctrl+t` with another keybind on your preference.
8585

86+
```shellscript
87+
# fish
88+
bind \ct f_run_icl
89+
90+
# zsh
91+
bindkey ^t w_run_icl
92+
93+
# Bash
94+
bind '"\C-t":"f_run_icl\n"'
95+
```
96+
97+
### Bonus: icl as a [TLDR](https://tldr.sh/) client
98+
The file `tldr.txt` includes all commands scrapped from tldr repository. If you want to be able to access them using icl, simply place them in your `commands.txt`. You can do so by running the following command.
8699
```
87100
curl https://raw.githubusercontent.com/plainas/icl/master/tldr.txt >> ~/.config/icl/commands.txt
88101
```
89102

103+
### TODO
104+
* accept an url as parameter to load an online library
105+
* include [cheat](https://github.com/cheat/cheat) and [eg](https://github.com/srsudar/eg)
106+
* integrate client to [bropages](http://bropages.org/)
107+
* Improve TLDR scraper, get ridd of curly brackets around paremeters.

0 commit comments

Comments
 (0)