Skip to content

Commit c8d5f92

Browse files
committed
Working on README.
1 parent e4f53f7 commit c8d5f92

File tree

9 files changed

+22
-5
lines changed

9 files changed

+22
-5
lines changed

README.md

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

44
the cookbook of git goodies
55

6-
```sh
7-
$ gg c Added introduction usage to README.
6+
![status](screenshots/status.png)
87

9-
10-
```
8+
`gg` helps you *work with `git` more efficiently*, saving you keystrokes for your most prized projects.
9+
10+
Think of `gg` as a wrapper for the `git` commands that you run all the time.
11+
12+
## Getting Started
13+
Suppose we want to clone the [awesome spark shell script (created by Zach Holman)](https://github.com/holman/spark).
14+
![status](screenshots/clone.png)
15+
Alright, let's switch into that directory.
16+
![status](screenshots/gettingstarted2.png)
17+
After making a quick change, let's check the status of our clone.
18+
![status](screenshots/gettingstarted3.png)
19+
Looks like we haven't staged our changes.
20+
21+
In the standard git workflow, we would have to `git add -A` and then `git commit -m "Updated example in README."`.
22+
23+
With `gg`, we can simply `gg c Updated example in README.` and we're good to go.
24+
![status](screenshots/gettingstarted4.png)
25+
Let's check our clone's status again.
26+
![status](screenshots/gettingstarted5.png)
27+
Looking good!

screenshots/clone.png

93.2 KB
Loading

screenshots/gettingstarted2.png

103 KB
Loading

screenshots/gettingstarted3.png

129 KB
Loading

screenshots/gettingstarted4.png

155 KB
Loading

screenshots/gettingstarted5.png

183 KB
Loading

screenshots/log.png

208 KB
Loading

screenshots/pull.png

91.4 KB
Loading

screenshots/push.png

91.5 KB
Loading

0 commit comments

Comments
 (0)