Skip to content

Commit f020c25

Browse files
committed
all: add an example
1 parent d85adb4 commit f020c25

File tree

6 files changed

+28
-11
lines changed

6 files changed

+28
-11
lines changed

README.md

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,16 @@
11
# code2img [![PkgGoDev](https://pkg.go.dev/badge/golang.design/x/code2img)](https://pkg.go.dev/golang.design/x/code2img) ![](https://changkun.de/urlstat?mode=github&repo=golang-design/code2img)
22

3-
a carbon service wrapper
3+
a carbon service wrapper for Go users
44

55
```go
66
import "golang.design/x/code2img"
77
```
88

99
## API Usage
1010

11-
Just one API `code2img.Render`, to use it:
11+
Just one API `code2img.Render`, to use it (see [main.go](./example/main.go)):
1212

13-
```go
14-
b, err := code2img.Render(context.TODO(), `import "golang.design/x/code2img"`)
15-
if err != nil {
16-
panic(err)
17-
}
18-
19-
os.WriteFile("code.png", b, os.ModePerm)
20-
```
13+
![](./example/code.png)
2114

2215
## Service Usage
2316

code2img_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ func TestRender(t *testing.T) {
2222
ctx, cancel := context.WithTimeout(context.Background(), time.Second*10)
2323
defer cancel()
2424

25-
got, err := code2img.Render(ctx, `import "golang.design/x/code2img`)
25+
got, err := code2img.Render(ctx, `import "golang.design/x/code2img"`)
2626
if err != nil {
2727
t.Fatalf("render failed: %v", err)
2828
}

example/code.png

48.5 KB
Loading

example/main.go

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
package main
2+
3+
import (
4+
"context"
5+
"os"
6+
7+
"golang.design/x/code2img"
8+
)
9+
10+
func main() {
11+
f, err := os.ReadFile("main.go")
12+
if err != nil {
13+
panic(err)
14+
}
15+
code := string(f)
16+
17+
// render it!
18+
b, err := code2img.Render(context.TODO(), code)
19+
if err != nil {
20+
panic(err)
21+
}
22+
23+
os.WriteFile("code.png", b, os.ModePerm)
24+
}

testdata/got.png

-11.3 KB
Binary file not shown.

testdata/want.png

-822 Bytes
Loading

0 commit comments

Comments
 (0)