Skip to content

Commit 85db56c

Browse files
committed
update readme
1 parent 408283d commit 85db56c

File tree

1 file changed

+13
-27
lines changed

1 file changed

+13
-27
lines changed

README.md

+13-27
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,37 @@
11
# ![amisgo](https://raw.githubusercontent.com/zrcoder/amisgo-assets/refs/heads/main/logo-with-text.svg)
2+
A Go package for building low-code frontend applications with Baidu [amis](https://aisuda.bce.baidu.com/amis).
23

3-
A low-code frontend framework for Go developers, powered by Baidu's [amis](https://aisuda.bce.baidu.com/amis).
4-
The name combines `amis` and `go`, which coincidentally means "friend" in Zulu.
4+
"amisgo" combines "amis" and "go", meaning "friend" in Zulu.
55

6-
For background info and deeper insights, check out our [documentation](https://amisgo.pages.dev) (in Chinese).
6+
For full documentation, visit [here](https://amisgo.pages.dev) (Chinese).
77

88
## Quick Start
99

1010
```go
1111
package main
1212

13-
import (
14-
"github.com/zrcoder/amisgo"
15-
)
13+
import "github.com/zrcoder/amisgo"
1614

1715
func main() {
1816
app := amisgo.New()
1917
index := app.Page().Title("amisgo").Body(
20-
app.Form().
21-
Api("https://xxx/api/saveForm").
22-
Body(
23-
app.InputText().Label("姓名").Name("name"),
24-
app.InputEmail().Label("邮箱").Name("email"),
25-
),
18+
app.Form().Api("https://xxx/api/saveForm").Body(
19+
app.InputText().Label("姓名").Name("name"),
20+
app.InputEmail().Label("邮箱").Name("email"),
21+
),
2622
)
2723
app.Mount("/", index)
28-
2924
panic(app.Run(":8080"))
3025
}
3126
```
3227

33-
Visit http://localhost:8080 after running the code.
34-
35-
## Tutorials
36-
37-
Explore our [documentation](https://amisgo.pages.dev) for in-depth tutorials and guides.
28+
Visit http://localhost:8080 to see the result.
3829

3930
## Use Cases
4031

41-
### [podFiles](https://github.com/zrcoder/podFiles)
42-
43-
PodFiles is a tool based on amisgo, designed to manage files within Kubernetes pods.
44-
45-
### [amisgo-examples](https://github.com/zrcoder/amisgo-examples)
46-
47-
amisgo-examples is a sample repository that demonstrates how to use amisgo, containing multiple examples, each of which has practical value.
32+
- [podFiles](https://github.com/zrcoder/podFiles) - Kubernetes pod file manager
33+
- [amisgo-examples](https://github.com/zrcoder/amisgo-examples) - Sample projects
4834

49-
## Issues and Contributions
35+
## Contributing
5036

51-
This project is primarily maintained on Gitee. For issues or pull requests, please visit https://gitee.com/rdor/amisgo
37+
For issues or pull requests, visit https://gitee.com/rdor/amisgo

0 commit comments

Comments
 (0)