Browse Source

Update 'README.md'

Ondřej Hruška 1 year ago
parent
commit
fc1b37139f
1 changed files with 10 additions and 11 deletions
  1. 10 11
      README.md

+ 10 - 11
README.md View File

@@ -1,13 +1,12 @@
1
-lazy-git
2
-========
1
+# lazy-git
2
+
3 3
 
4 4
 Script for automating the most common git tasks.
5 5
 If you are lazy, this may be for you :)
6 6
 
7
-Usage
8
------
7
+## Usage
9 8
 
10
-**Clone github repo**
9
+### Clone github repo
11 10
 
12 11
 Commands you want:
13 12
 
@@ -19,7 +18,7 @@ With LazyGit:
19 18
 ghc MightyPork/lazy-git
20 19
 ```
21 20
 
22
-**Check git status**
21
+### Check git status
23 22
 
24 23
 Commands you want:
25 24
 
@@ -31,7 +30,7 @@ With LazyGit:
31 30
 g check
32 31
 ```
33 32
 
34
-**Pull from origin**
33
+### Pull from origin
35 34
 
36 35
 Commands you want:
37 36
 - ` git pull`
@@ -42,7 +41,7 @@ With LazyGit:
42 41
 g pull
43 42
 ```
44 43
 
45
-**Commit and push to origin**
44
+### Add all, commit and push
46 45
 
47 46
 Commands you want:
48 47
 
@@ -58,10 +57,9 @@ g send
58 57
 ```
59 58
 
60 59
 `g send` is interactive, it shows you the changes and prompts for a message.
60
+The operation can be canceled without damage by hitting ^C at the commit prompt.
61 61
 
62
-**Commit without push**
63
-
64
-Commands you want:
62
+### Add all & commit (without push)
65 63
 
66 64
 This is like `g send`, but without pushing the result. Use `g push` or `git push` 
67 65
 to send your new commits to the server.
@@ -70,3 +68,4 @@ to send your new commits to the server.
70 68
 g add
71 69
 ```
72 70
 
71
+(`g commit` and `g stage` are aliases)