|
1 | | -# Git Cheats - *Cheatsheet For Git Commands* |
2 | | -**Git Cheats CLI** is a companion app for [GitCheats](http://gitcheats.com/) where you can directly fetch git command descriptions into your terminal. |
| 1 | +<p align="center"> |
| 2 | + <h1 align="center">Git Cheats - <i>Cheatsheet For Git Commands</i></h1> |
| 3 | +</p> |
| 4 | +<p align = "center"> |
| 5 | + A companion app for <a href="http://gitcheats.com/">Git Cheats</a> where you can fetch git descriptions directly into your terminal |
| 6 | +</p> |
| 7 | +<p align="center"> |
| 8 | + <img src="screenshot.gif"> |
| 9 | +</p> |
3 | 10 |
|
| 11 | +<p align="center"> |
| 12 | + <a href="https://travis-ci.org/excalith/Git-Cheats-Cli"> |
| 13 | + <img alt="Build Status" height="18" src="https://img.shields.io/travis/excalith/Git-Cheats-Cli.svg"> |
| 14 | + </a> |
| 15 | + <a href="https://github.com/excalith/Git-Cheats-Cli/issues"> |
| 16 | + <img alt="Build Status" height="18" src="https://img.shields.io/github/issues/excalith/Git-Cheats-Cli.svg"> |
| 17 | + </a> |
| 18 | + <a href="https://github.com/excalith/Git-Cheats-Cli/stargazers"> |
| 19 | + <img alt="Stars" height="18" src="https://img.shields.io/github/stars/excalith/Git-Cheats-Cli.svg"> |
| 20 | + </a> |
| 21 | + <a href="https://github.com/excalith/Git-Cheats-Cli/network"> |
| 22 | + <img alt="Forks" height="18" src="https://img.shields.io/github/forks/excalith/Git-Cheats-Cli.svg"> |
| 23 | + </a> |
| 24 | + <a href="https://prettier.io/"> |
| 25 | + <img alt="Prettier" height="18" src="https://img.shields.io/badge/code_style-prettier-ff69b4.svg"> |
| 26 | + </a> |
| 27 | +</p> |
4 | 28 |
|
5 | | - |
| 29 | +<hr/> |
| 30 | + |
| 31 | +**Git Cheats** is a small project for people who wants to get into git using commands but don't know where to start. It started as a side-project to help my friends / colleagues check commands easily, but it turned out it has been shared through my friends lots of times and it is being used on a daily basis. Suprising enough, I wanted to create a project for this. Maybe someone finds it useful and / or wants to contribute! |
| 32 | + |
| 33 | +You can either use web based [GitCheats App](http://gitcheats.com) from your browser or use this GitCheats CLI right from your terminal. |
6 | 34 |
|
7 | 35 | ## How To Install: |
8 | | -* Requirements |
9 | | - * [NodeJS](https://nodejs.org) |
10 | | - * [NPM](https://www.npmjs.com/get-npm) |
11 | | -* Clone or Download this repository |
12 | | -* Within the directory, from your favorite terminal |
13 | | - * npm install |
14 | | - * npm link (might ask for permission depending on your OS) |
15 | | -* Now you can use gitcheats directly from your terminal! |
| 36 | + |
| 37 | +- Requirements |
| 38 | + - [NodeJS](https://nodejs.org) |
| 39 | + - [NPM](https://www.npmjs.com/get-npm) |
| 40 | +- Clone or Download this repository |
| 41 | +- Within the directory, from your favorite terminal |
| 42 | + - npm install |
| 43 | + - npm link (might ask for permission depending on your OS) |
| 44 | +- Now you can use gitcheats directly from your terminal! |
16 | 45 |
|
17 | 46 | ## Available Commands: |
18 | | -| *Command* | *Description* | |
19 | | -| ---------------------------- |------------------------------------------------------------| |
| 47 | + |
| 48 | +| _Command_ | _Description_ | |
| 49 | +| ---------------------------- | ---------------------------------------------------------- | |
20 | 50 | | gitcheats | Launch gitcheats.com directly | |
21 | 51 | | gitcheats [command] | Print command descriptions right into your terminal | |
22 | 52 | | gitcheats --launch [command] | Launch gitcheats.com in browser with your command filtered | |
23 | 53 | | gitcheats --help | Show commands for the app | |
24 | 54 |
|
25 | 55 | ## How To Contribute: |
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. |
| 56 | + |
| 57 | +- If you want to add more commands into GitCheats, please contribute to original [GitCheats Repository](https://github.com/excalith/Git-Cheats). |
| 58 | +- If you want to further improve CLI app, please send a pull request to this repository. |
28 | 59 |
|
29 | 60 | ## License |
30 | | -This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details. |
| 61 | + |
| 62 | +This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details. |
0 commit comments