Skip to content

Commit c3aa5d0

Browse files
committed
Added example images and screenshots to README.
1 parent c8d5f92 commit c3aa5d0

File tree

3 files changed

+66
-6
lines changed

3 files changed

+66
-6
lines changed

README.md

Lines changed: 66 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,87 @@
1-
`gg`
1+
gg
22
==
33

44
the cookbook of git goodies
55

66
![status](screenshots/status.png)
7+
![log](screenshots/log.png)
8+
79

810
`gg` helps you *work with `git` more efficiently*, saving you keystrokes for your most prized projects.
911

1012
Think of `gg` as a wrapper for the `git` commands that you run all the time.
1113

1214
## Getting Started
13-
Suppose we want to clone the [awesome spark shell script (created by Zach Holman)](https://github.com/holman/spark).
15+
After the [super painless installation](#installation), suppose we want to clone the [awesome spark shell script (created by Zach Holman)](https://github.com/holman/spark).
1416
![status](screenshots/clone.png)
1517
Alright, let's switch into that directory.
16-
![status](screenshots/gettingstarted2.png)
18+
![gettingstarted2](screenshots/gettingstarted2.png)
1719
After making a quick change, let's check the status of our clone.
18-
![status](screenshots/gettingstarted3.png)
20+
![gettingstarted3](screenshots/gettingstarted3.png)
1921
Looks like we haven't staged our changes.
2022

2123
In the standard git workflow, we would have to `git add -A` and then `git commit -m "Updated example in README."`.
2224

2325
With `gg`, we can simply `gg c Updated example in README.` and we're good to go.
24-
![status](screenshots/gettingstarted4.png)
26+
![gettingstarted4](screenshots/gettingstarted4.png)
2527
Let's check our clone's status again.
26-
![status](screenshots/gettingstarted5.png)
28+
![gettingstarted5](screenshots/gettingstarted5.png)
2729
Looking good!
30+
31+
## Installation
32+
`gg` can be installed via the Node Package Manager (`npm`).
33+
34+
```sh
35+
$ npm install -g gg
36+
```
37+
You can also get up and running without npm, but it is not recommended to do so.
38+
39+
`gg` relies on Node.js and `git`.
40+
41+
## Usage
42+
### Initializing repositories
43+
![initialize](screenshots/initialize.png)
44+
* `$ gg i`
45+
* `$ gg init`
46+
* `$ gg initialize`
47+
48+
### Cloning repositories
49+
![clone](screenshots/clone.png)
50+
* `$ gg cl`
51+
* `$ gg clone`
52+
53+
### Adding changes
54+
![add](screenshots/add.png)
55+
* `$ gg a`
56+
* `$ gg aa # add all`
57+
* `$ gg add`
58+
59+
### Committing changes
60+
![commit](screenshots/commit.png)
61+
* `$ gg c`
62+
* `$ gg commit`
63+
64+
### Pushing commits
65+
![push](screenshots/push.png)
66+
* `$ gg p`
67+
* `$ gg push`
68+
69+
### Pulling commits
70+
![pull](screenshots/pull.png)
71+
* `$ gg pl`
72+
* `$ gg pull`
73+
74+
### Fetching commits
75+
![fetch](screenshots/fetch.png)
76+
* `$ gg f`
77+
* `$ gg fetch`
78+
79+
### Viewing status
80+
![status](screenshots/status.png)
81+
* `$ gg s`
82+
* `$ gg status`
83+
84+
### Viewing log
85+
![log](screenshots/log.png)
86+
* `$ gg l`
87+
* `$ gg log`

screenshots/fetch.png

87.6 KB
Loading

screenshots/initialize.png

89.4 KB
Loading

0 commit comments

Comments
 (0)