Skip to content

Commit a4bbf1d

Browse files
committed
update README.md
1 parent 1353b43 commit a4bbf1d

File tree

2 files changed

+61
-20
lines changed

2 files changed

+61
-20
lines changed

README-zh_CN.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
[English](./README.md) | 简体中文
2+
3+
<div align="center">
4+
<img src="https://github.com/maiqingqiang/go-orm-helper/raw/main/src/main/resources/icons/icon64x64.svg" alt="Go ORM Helper"/>
5+
<h1 align="center">Go ORM Helper</h1>
6+
</div>
7+
8+
<p align="center">一个为了让你在 Goland 上写 ORM 能自动补全数据库字段、Tag、生成Struct 的 Jetbrains 插件。支持:gorm、xorm、beego、database/sql...)</p>
9+
10+
> 灵感来源 [Laravel Idea](https://plugins.jetbrains.com/plugin/13441-laravel-idea) &
11+
> [PhpStorm metadata](https://www.jetbrains.com/help/phpstorm/ide-advanced-metadata.html)。 本人使用 golang 的 orm 包时,
12+
> 一些 ORM 函数的参数是字符串,并且ide不支持代码补全,在字段贼多的情况下,记不清楚,写起来就会很不方便。以前本人写php的时候,就用到前面的插件,
13+
> 感觉非常爽,所以就有了这个插件~~
14+
15+
## 特性
16+
17+
- [x] ORM 代码补全
18+
- [x] @Model 注解辅助补全
19+
- [ ] @Table 注解辅助补全 🚧[WIP]
20+
- [ ] 自定义 SQL 辅助不全 🚧[WIP]
21+
- [x] SQL 转 Struct
22+
- [x] Gorm
23+
- [x] Xorm
24+
- [x] 通用 Struct
25+
- [ ] GoFrame
26+
- [ ] Beego
27+
- [ ] sqlx
28+
- [ ] Tag 代码补全 🚧[WIP]
29+
- 更多等你去发现与改进...
30+
31+
## 支持的ORM
32+
33+
- [x] [Gorm](https://github.com/go-gorm/gorm)
34+
- [x] [Xorm](https://gitea.com/xorm/xorm)
35+
- [ ] [GoFrame](https://github.com/gogf/gf) 🚧[WIP]
36+
- [ ] [Beego](https://github.com/beego/beego) 🚧[WIP]
37+
- [ ] [sqlx](https://github.com/jmoiron/sqlx) 🚧[WIP]
38+
- 更多等你去发现与改进...
39+
40+
## 使用
41+
42+
![guide.gif](assets%2Fguide.gif)

README.md

Lines changed: 19 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,43 @@
11
<!-- Plugin description -->
2+
English | [简体中文](./README-zh_CN.md)
23

34
<div align="center">
45
<img src="https://github.com/maiqingqiang/go-orm-helper/raw/main/src/main/resources/icons/icon64x64.svg" alt="Go ORM Helper"/>
56
<h1 align="center">Go ORM Helper</h1>
67
</div>
78

8-
<p align="center">一个为了让你在 Goland 上写 ORM 能自动补全数据库字段、Tag、生成Struct 的 Jetbrains 插件。支持:gormxormbeegodatabase/sql...)</p>
9+
<p align="center">A JetBrains plugin for GoLand that automatically provides database field autocompletion, tags, and generates Structs for writing ORM code. Supports: gorm, xorm, beego, database/sql, etc.</p>
910

10-
> 灵感来源 [Laravel Idea](https://plugins.jetbrains.com/plugin/13441-laravel-idea) &
11-
> [PhpStorm metadata](https://www.jetbrains.com/help/phpstorm/ide-advanced-metadata.html)。 本人使用 golang 的 orm 包时,
12-
> 一些 ORM 函数的参数是字符串,并且ide不支持代码补全,在字段贼多的情况下,记不清楚,写起来就会很不方便。以前本人写php的时候,就用到前面的插件,
13-
> 感觉非常爽,所以就有了这个插件~~
11+
> Inspired by [Laravel Idea](https://plugins.jetbrains.com/plugin/13441-laravel-idea) &
12+
> [PhpStorm metadata](https://www.jetbrains.com/help/phpstorm/ide-advanced-metadata.html). When using ORM packages in Golang,
13+
> I noticed that some ORM function parameters are strings and the IDE does not support code completion. It becomes inconvenient
14+
> to write code when dealing with numerous fields. Previously, when I was writing PHP, I used similar plugins and found them
15+
> extremely useful. Hence, this plugin was developed.
1416
15-
## 特性
16-
17-
- [x] ORM 代码补全
18-
- [x] @Model 注解辅助补全
19-
- [ ] @Table 注解辅助补全 🚧[WIP]
20-
- [ ] 自定义 SQL 辅助不全 🚧[WIP]
21-
- [x] SQL 转 Struct
17+
## Features
18+
- [x] ORM code autocompletion
19+
- [x] Assisted completion with @Model annotation
20+
- [ ] Assisted completion with @Table annotation 🚧[WIP]
21+
- [ ] Assisted completion for custom SQL 🚧[WIP]
22+
- [x] SQL to Struct conversion
2223
- [x] Gorm
2324
- [x] Xorm
24-
- [x] 通用 Struct
25+
- [x] Generic Struct
2526
- [ ] GoFrame
2627
- [ ] Beego
2728
- [ ] sqlx
28-
- [ ] Tag 代码补全 🚧[WIP]
29-
- 更多等你去发现与改进...
30-
31-
## 支持的ORM
29+
- [ ] Tag code autocompletion 🚧[WIP]
30+
- More features waiting to be discovered and improved...
3231

32+
## Supported ORM Packages
3333
- [x] [Gorm](https://github.com/go-gorm/gorm)
3434
- [x] [Xorm](https://gitea.com/xorm/xorm)
3535
- [ ] [GoFrame](https://github.com/gogf/gf) 🚧[WIP]
3636
- [ ] [Beego](https://github.com/beego/beego) 🚧[WIP]
3737
- [ ] [sqlx](https://github.com/jmoiron/sqlx) 🚧[WIP]
38-
- 更多等你去发现与改进...
39-
40-
## 使用
38+
- More packages waiting to be discovered and improved...
4139

40+
## Usage
4241
![guide.gif](assets%2Fguide.gif)
4342

4443
<!-- Plugin description end -->

0 commit comments

Comments
 (0)