Skip to content

Commit 6f688ef

Browse files
committed
Add reference do doc/standalone.md (#14, chubin#97, chubin#98)
1 parent 831f4c5 commit 6f688ef

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,10 @@ Such a thing exists.
2222

2323
**cheat.sh**
2424

25-
* Has a simple curl/browser interface.
25+
* Has a simple curl/browser/editor interface.
2626
* Covers 56 programming languages, several DBMSes, and more than 1000 most important UNIX/Linux commands.
2727
* Provides access to the best community driven cheat sheets repositories in the world, on par with StackOverflow.
28-
* Available everywhere, no installation needed.
28+
* Available everywhere, no installation needed, but can be installed for offline usage.
2929
* Ultrafast, returns answers within 100 ms, as a rule.
3030
* Has a convenient command line client, `cht.sh`, that is very advantageous and helpful, though not mandatory.
3131
* Can be used directly from code editors, without opening a browser and not switching your mental context.
@@ -865,3 +865,15 @@ If you want to add a cheat sheet repository to cheat.sh, please open an issue:
865865
* [Add a new repository](https://github.com/chubin/cheat.sh/issues/new)
866866

867867
Please specify the name of the repository, and give its short description.
868+
869+
870+
## Installation and standalone usage
871+
872+
You don't need to install anything, to start using *cheat.sh*.
873+
874+
There are two cases, when you want to install *cheat.sh* locally:
875+
876+
1. You plan to use it off-line, without Internet access;
877+
2. You want to use your own cheat sheets (additionally, or as a replacement).
878+
879+
Installation process in described in details here: [cheat.sh standalone installation](doc/standalone.md)

0 commit comments

Comments
 (0)