docs: update readme

normal-coder · Dec 21, 2022 · e29be5b · e29be5b
1 parent 872fed8
commit e29be5b
Show file tree

Hide file tree

Showing 2 changed files with 46 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,23 @@
-# sql2builder.github.io
-Convert  legacy SQL to Laravel query builder.
+# SQL2Builder
+
+[SQL2Builder](https://github.com/sql2builder/sql2builder.github.io) converts SQL to Laravel Query Builder.
+
+## Quick start
+
+Running SQL2Builder on Docker
+
+```bash
+docker run --name sql2builder -d -p 8877:80 normalcoder/sql2builder:v1.0
+```
+
+After the container starts, visit [http://loclahost:8877](http://loclahost:8877)
+
+## Build it yourself
+
+```bash
+docker build -t normalcoder/sql2builder:v1.0 .
+```
+
+## Acknowledgments
+
+Project Fork from [sql2builder/sql2builder.github.io](https://github.com/sql2builder/sql2builder.github.io)
diff --git a/Readme.zh-CN.md b/Readme.zh-CN.md
@@ -0,0 +1,23 @@
+# SQL2Builder
+
+[SQL2Builder](https://github.com/sql2builder/sql2builder.github.io) 可以将 SQL 转换为 Laravel 查询构造器 (Query Builder)。
+
+## 快速开始
+
+基于 Docker 运行 SQL2Builder
+
+```bash
+docker run --name sql2builder -d -p 8877:80 normalcoder/sql2builder:v1.0
+```
+
+容器启动后，访问 [http://loclahost:8877](http://loclahost:8877) 即可
+
+## 自行构建
+
+```bash
+docker build -t normalcoder/sql2builder:v1.0 .
+```
+
+## 致谢
+
+项目 Fork 自 [sql2builder/sql2builder.github.io](https://github.com/sql2builder/sql2builder.github.io)