Skip to content

Commit b390f93

Browse files
authored
Provide more description
1 parent 5e7b8c3 commit b390f93

File tree

1 file changed

+28
-8
lines changed

1 file changed

+28
-8
lines changed

README.md

Lines changed: 28 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,38 @@
66

77
cgit is a wrapper of git.
88

9-
# Get started
10-
11-
Clone a repo from GitHub without the whole URL: `cgit clone linuxsuren/cgit`
12-
13-
Sometimes it's very slow when clone the code from GitHub. So cgit will clone it by [a GitHub proxy](http://github.com.cnpmjs.org/).
14-
15-
Provide an alias for git: `cgit alias set cm 'checkout master'`, then you can checkout branch to master via: `cgit cm`
9+
# Features
1610

17-
List all alias commands: `cgit alias list`
11+
* Clone a repo from GitHub without the whole URL
12+
* GitHub proxy transparent support
13+
* Git command alias support
1814

1915
# Install
2016

2117
```
2218
brew install linuxsuren/linuxsuren/cgit
2319
```
20+
21+
cgit is fully compatible with git. So you make an alias for it. Add the following line into you shell profile:
22+
23+
`alias git='cgit'`
24+
25+
For bash users, you edit it via: `vim ~/.bashrc`
26+
27+
For zsh users, you can edit via: `vim ~/.zshrc`
28+
29+
# Get started
30+
31+
## Clone
32+
33+
`cgit clone linuxsuren/cgit`
34+
35+
## GitHub Proxy
36+
37+
Sometimes it's very slow when clone the code from GitHub. So cgit will clone it by [a GitHub proxy](http://github.com.cnpmjs.org/).
38+
39+
## Alias
40+
41+
Add a command alias: `cgit alias set cm 'checkout master'`
42+
Use an alias: `cgit cm`
43+
List all alias commands: `cgit alias list`

0 commit comments

Comments
 (0)