|
1 | 1 | # Git Cheats - *Cheatsheet For Git Commands* |
2 | 2 | **Git Cheats CLI** is a companion app for [GitCheats](http://gitcheats.com/) where you can directly fetch git command descriptions into your terminal. |
3 | 3 |
|
| 4 | + |
| 5 | + |
| 6 | + |
4 | 7 | ## How To Install: |
5 | | -* Install NPM |
| 8 | +* Requirements |
| 9 | + * [NodeJS](https://nodejs.org) |
| 10 | + * [NPM](https://www.npmjs.com/get-npm) |
6 | 11 | * Clone or Download this repository |
7 | 12 | * Within the directory, from your favorite terminal |
8 | 13 | * npm install |
9 | | - * npm link |
| 14 | + * npm link (might ask for permission depending on your OS) |
10 | 15 | * Now you can use gitcheats directly from your terminal! |
11 | 16 |
|
12 | 17 | ## 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 | |
19 | 24 |
|
20 | 25 | ## 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. |
23 | 28 |
|
24 | 29 | ## License |
25 | 30 | This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details. |
0 commit comments