Skip to content

Commit 66f1df7

Browse files
committed
Update README
Signed-off-by: Xiang Dai <[email protected]>
1 parent 106b42d commit 66f1df7

File tree

1 file changed

+82
-6
lines changed

1 file changed

+82
-6
lines changed

README.md

Lines changed: 82 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,11 @@ usage: gci [flags] [path ...]
2121
-w write result to (source) file instead of stdout
2222
```
2323

24-
## Example
24+
## Examples
2525

26-
main.go:
26+
Run `gci -w -local github.com/daixiang0/gci main.go` and you will handle following cases.
27+
28+
### simple case
2729

2830
```go
2931
package main
@@ -34,12 +36,11 @@ import (
3436

3537
"github.com/daixiang0/gci"
3638
)
37-
3839
```
3940

40-
```shell
41-
$ gci -w -local github.com/daixiang0/gci main.go
42-
$ cat main.go
41+
to
42+
43+
```go
4344
package main
4445
import (
4546
"fmt"
@@ -50,6 +51,81 @@ import (
5051
)
5152
```
5253

54+
### with alias
55+
56+
```go
57+
package main
58+
import (
59+
"fmt"
60+
go "github.com/golang"
61+
"github.com/daixiang0"
62+
)
63+
```
64+
65+
to
66+
67+
```go
68+
package main
69+
import (
70+
"fmt"
71+
72+
go "github.com/golang"
73+
74+
"github.com/daixiang0/gci"
75+
)
76+
```
77+
78+
### with comment and alias
79+
80+
```go
81+
package main
82+
import (
83+
"fmt"
84+
_ "github.com/golang" // golang
85+
"github.com/daixiang0"
86+
)
87+
```
88+
89+
to
90+
91+
```go
92+
package main
93+
import (
94+
"fmt"
95+
96+
// golang
97+
_ "github.com/golang"
98+
99+
"github.com/daixiang0/gci"
100+
)
101+
```
102+
103+
### with above comment and alias
104+
105+
```go
106+
package main
107+
import (
108+
"fmt"
109+
// golang
110+
_ "github.com/golang"
111+
"github.com/daixiang0"
112+
)
113+
```
114+
115+
to
116+
117+
```go
118+
package main
119+
import (
120+
"fmt"
121+
122+
// golang
123+
_ "github.com/golang"
124+
125+
"github.com/daixiang0/gci"
126+
)
127+
```
128+
53129
## TODO
54130

55131
- Support multi-3rd-party packages

0 commit comments

Comments
 (0)