docs: cleanup and update documentation

si3nloong · Nov 14, 2023 · b8226c6 · b8226c6
1 parent cca0c3d
commit b8226c6
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 89 deletions.
diff --git a/.air.toml b/.air.toml
diff --git a/config.yml b/config.yml
diff --git a/docs/BENCHMARK.md b/docs/BENCHMARK.md
diff --git a/docs/MODELS.md b/docs/MODELS.md
@@ -8,6 +8,15 @@ Format
 `sql:"[column name],[tag options...]"`
 ```
 
+Example:
+
+```go
+type User struct{
+    ID   int64  `sql:",pk,auto_increment"`
+    Name string `sql:",size:10"`
+}
+```
+
 Tags are case insensitive, however `snake_case` is preferred. Tags are optional to use when declaring models, `sqlgen` supports the following tags:
 
 | Tag Name         | Alias | Description                                                                                                      | Example                                                                |

diff --git a/docs/TYPE_MAPPING.md b/docs/TYPE_MAPPING.md
@@ -7,7 +7,7 @@ A scalar message field can have one of the following types – the table shows t
 | `~string`                        | VARCHAR(255)       | VARCHAR(255)          | VARCHAR(255)        |
 | `~[]byte`                        | BLOB               | BLOB                  | BLOB                |
 | `~[16]byte`                      | BINARY(16)         | BINARY(16)            | BINARY(16)          |
-| `sql.RawBytes`                   | VARCHAR(255)       | VARCHAR(255)          | VARCHAR(255)        |
+| `database/sql.RawBytes`          | VARCHAR(255)       | VARCHAR(255)          | VARCHAR(255)        |
 | `~int`                           | INTEGER            | INTEGER               | INTEGER             |
 | `~int8`                          | TINYINT            | TINYINT               | TINYINT             |
 | `~int16`                         | SMALLINT           | SMALLINT              | SMALLINT            |