Skip to content
This repository was archived by the owner on Apr 25, 2023. It is now read-only.

Commit 46ddc90

Browse files
committed
Improve README.md
1 parent 86afb19 commit 46ddc90

File tree

2 files changed

+15
-10
lines changed

2 files changed

+15
-10
lines changed

README.md

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,30 @@
11
# Git Cheats - *Cheatsheet For Git Commands*
22
**Git Cheats CLI** is a companion app for [GitCheats](http://gitcheats.com/) where you can directly fetch git command descriptions into your terminal.
33

4+
5+
![Screenshot](screenshot.png)
6+
47
## How To Install:
5-
* Install NPM
8+
* Requirements
9+
* [NodeJS](https://nodejs.org)
10+
* [NPM](https://www.npmjs.com/get-npm)
611
* Clone or Download this repository
712
* Within the directory, from your favorite terminal
813
* npm install
9-
* npm link
14+
* npm link (might ask for permission depending on your OS)
1015
* Now you can use gitcheats directly from your terminal!
1116

1217
## Available Commands:
13-
| Command | Description |
14-
| ---------------------------- |-------------|
15-
| gitcheats [command] | Print command descriptions right into your terminal |
16-
| gitcheats --launch [command] | Launch GitCheats.com in browser with your command filtered |
17-
| gitcheats --help | Show commands for the app |
18-
18+
| *Command* | *Description* |
19+
| ---------------------------- |------------------------------------------------------------|
20+
| gitcheats | Launch gitcheats.com directly |
21+
| gitcheats [command] | Print command descriptions right into your terminal |
22+
| gitcheats --launch [command] | Launch gitcheats.com in browser with your command filtered |
23+
| gitcheats --help | Show commands for the app |
1924

2025
## How To Contribute:
21-
* If you want to contribute more commands into GitCheats, please checkout to [GitCheats Repository](https://github.com/excalith/Git-Cheats).
22-
* If you want to further improve CLI app, please send a pull request.
26+
* If you want to add more commands into GitCheats, please contribute to original [GitCheats Repository](https://github.com/excalith/Git-Cheats).
27+
* If you want to further improve CLI app, please send a pull request to this repository.
2328

2429
## License
2530
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.

screenshot.png

45.7 KB
Loading

0 commit comments

Comments
 (0)