Skip to content

Commit 325a35d

Browse files
committed
docs: update information on README.md
1 parent cf7e6c5 commit 325a35d

File tree

1 file changed

+58
-45
lines changed

1 file changed

+58
-45
lines changed

README.md

Lines changed: 58 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -32,59 +32,53 @@ However, some developers forget to delete their logs after resolving the problem
3232
It doesn't contain a generics feature.
3333

3434
```bash
35-
$ go install github.com/task4233/dl/cmd/dl@latest
35+
$ go install github.com/task4233/dl/cmd/dl@v1
3636
```
3737

3838
### Go 1.18
3939

4040
```bash
41-
$ go install github.com/task4233/dl/cmd/dl/v2@latest
41+
$ go install github.com/task4233/dl/cmd/dl@main
4242
```
4343

4444
## Usage
4545

4646
1. debug your codes with `dl` package
4747

48-
[Playground](https://go.dev/play/p/GRucgd6JhPk)
48+
[Playground](https://go.dev/play/p/PWJAD4tvLLS)
4949
```go
5050
package main
5151

5252
import (
53-
"os"
54-
5553
"github.com/task4233/dl"
5654
)
5755

58-
type U[T interface{}] []T
56+
type T []int
5957

60-
func (t U[T]) append(v T) {
58+
func (t T) append(v int) {
6159
t = append(t, v)
62-
// debug
63-
dl.Info(t)
60+
dl.Printf("t: %#v, v: %d\n", t, v)
6461
}
6562

66-
func (t U[T]) change(v T) {
63+
func (t T) change(v int) {
6764
t[0] = v
68-
// debug
69-
dl.FInfo(os.Stdout, t)
65+
dl.Printf("t: %#v, v: %d\n", t, v)
7066
}
7167

7268
func main() {
73-
t := U[int]([]int{1, 3})
69+
var t T = []int{1, 3}
7470
t.append(5)
7571
t.change(5)
7672
}
7773

78-
7974
// Output:
80-
// [DeLog] info: main.U[int]{1, 3, 5} (main.U[int]) prog.go:13
81-
// [DeLog] info: main.U[int]{5, 3} (main.U[int]) prog.go:18
75+
// t: main.T{1, 3, 5}, v: 5
76+
// t: main.T{5, 3}, v: 5
8277
```
8378

8479
2. Install dl
8580

8681
```bash
87-
$
8882
$ dl init .
8983
```
9084

@@ -97,19 +91,27 @@ $ cat main.go
9791
package main
9892

9993
import (
100-
"fmt"
101-
10294
"github.com/task4233/dl"
10395
)
10496

105-
func SayHi(v interface{}) {
106-
dl.Printf("v: %v\n", v) // This statement can be removed by `$ dl clean main.go`
107-
fmt.Println("Hi, ", v)
97+
type T []int
98+
99+
func (t T) append(v int) {
100+
t = append(t, v)
101+
dl.Printf("t: %#v, v: %d\n", t, v)
102+
}
103+
104+
func (t T) change(v int) {
105+
t[0] = v
106+
dl.Printf("t: %#v, v: %d\n", t, v)
108107
}
109108

110109
func main() {
111-
SayHi("hoge")
110+
var t T = []int{1, 3}
111+
t.append(5)
112+
t.change(5)
112113
}
114+
113115
```
114116

115117
- invoke `$ git commit`
@@ -126,26 +128,30 @@ remove dl from main.go # automatically removed
126128
- `delog` is removed automatically
127129

128130
```bash
129-
$ git diff HEAD^
130-
diff --git a/main.go b/main.go
131+
$ git show HEAD
131132
index 90a78bd..0e28e8a 100644
132133
--- a/main.go
133134
+++ b/main.go
134135
@@ -1,21 +1,12 @@
135-
package main
136-
137-
+import (
138-
+ "fmt"
139-
+)
140-
141-
+ func SayHi(v interface{}) {
142-
+ dl.Printf("v: %v\n", v) // This statement can be removed by `$ dl clean main.go`
143-
+ fmt.Println("Hi, ", v)
144-
+ }
145-
146-
func main() {
147-
+ SayHi("hoge")
148-
}
136+
package main
137+
138+
type T []int
139+
140+
func (t T) append(v int) {
141+
t = append(t, v)
142+
143+
}
144+
145+
func (t T) change(v int) {
146+
t[0] = v
147+
148+
}
149+
150+
func main() {
151+
var t T = []int{1, 3}
152+
t.append(5)
153+
t.change(5)
154+
}
149155
```
150156

151157
- removed `delog` codes are restored(not commited)
@@ -155,18 +161,25 @@ $ cat main.go
155161
package main
156162

157163
import (
158-
"fmt"
159-
160164
"github.com/task4233/dl"
161165
)
162166

163-
func SayHi(v interface{}) {
164-
dl.Printf("v: %v\n", v) // This statement can be removed by `$ dl clean main.go`
165-
fmt.Println("Hi, ", v)
167+
type T []int
168+
169+
func (t T) append(v int) {
170+
t = append(t, v)
171+
dl.Printf("t: %#v, v: %d\n", t, v)
172+
}
173+
174+
func (t T) change(v int) {
175+
t[0] = v
176+
dl.Printf("t: %#v, v: %d\n", t, v)
166177
}
167178

168179
func main() {
169-
SayHi("hoge")
180+
var t T = []int{1, 3}
181+
t.append(5)
182+
t.change(5)
170183
}
171184
```
172185

0 commit comments

Comments
 (0)