Skip to content

Commit 979db65

Browse files
authored
Merge pull request chubin#283 from hangtwenty/patch-1
README - small changes
2 parents 7347f42 + 09811e6 commit 979db65

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

README.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ What features should it have?
1515
* **Tutoring** — It should help you to learn the subject.
1616
* **Inconspicuous** — It should be possible to use it completely unnoticed.
1717

18-
Such a thing exists.
18+
Such a thing exists! It's easy to [install](#installation) and there's even [auto-complete](#tab-completion).
1919

2020

2121
## Features
@@ -187,6 +187,8 @@ Try your own queries. Follow these rules:
187187

188188
Read more about the programming languages queries below.
189189

190+
----
191+
190192
## Command line client, cht.sh
191193

192194
The cheat.sh service has its own command line client (`cht.sh`) that
@@ -203,9 +205,10 @@ has several useful features compared to querying the service directly with `curl
203205
To install the client:
204206

205207
```
206-
mkdir -p ~/bin/
207-
curl https://cht.sh/:cht.sh > ~/bin/cht.sh
208-
chmod +x ~/bin/cht.sh
208+
PATH_DIR="$HOME/bin" # or another directory on your $PATH
209+
mkdir -p "$PATH_DIR"
210+
curl https://cht.sh/:cht.sh > "$PATH_DIR/cht.sh"
211+
chmod +x "$PATH_DIR/cht.sh"
209212
```
210213

211214
or to install it globally (for all users):
@@ -342,6 +345,8 @@ To activate tab completion support for `cht.sh`, add the `:zsh` script to the *f
342345
$ # Open a new shell to load the plugin
343346
```
344347

348+
----
349+
345350
### Stealth mode
346351

347352
Being used fully unnoticed is one of the most important property of any cheat sheet.
@@ -442,6 +447,8 @@ You can also use [`scoop`](https://github.com/lukesampson/scoop) command-line in
442447
scoop install cht
443448
```
444449

450+
----
451+
445452
## Self-Hosting
446453

447454
### Docker

0 commit comments

Comments
 (0)