update README.md with a few more descriptions.

liupangzi · Oct 8, 2019 · 8f7e71b · 8f7e71b
1 parent b9ad15f
commit 8f7e71b
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,7 +1,17 @@
 ## GPA: yet another Golang Persistence API
 
+### Installation
+
+```bash
+go get github.com/liupangzi/gpa
+```
+
+### Document
+
 #### 1. .sql to Go struct
 
+`gpa mysql model -h` can translate mysql ddl file to Go struct respecting the data alignment, e.g.:
+
 - .sql ddl file
 ![sql](./docs/images/sql.png "ddl")
 
@@ -10,6 +20,8 @@
 
 #### 2. Interface to Implementation
 
+`gpa mysql impl -h` will generate Go implementations from pre-defined interface based on [sqlx](https://github.com/jmoiron/sqlx), e.g.:
+
 - Golang interface with annotations
 ![interface](./docs/images/interface.png "Golang interface with annotations")
 

diff --git a/cmd/root.go b/cmd/root.go
@@ -8,7 +8,7 @@ var RootCmd = &cobra.Command{
 	Use:     "gpa",
 	Short:   "Golang Persistence API",
 	Long:    "Golang programming interface that describes the management of MySQL data in applications.",
-	Version: "0.1.0",
+	Version: "v1.0.2",
 }
 
 func init() {