docs: add import notice to README and example (openGemini#41)

Signed-off-by: PennyYoon <525296438@qq.com>
Chenxulin97 · Jan 29, 2024 · e5c057e · e5c057e
1 parent 35a09f6
commit e5c057e
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -9,10 +9,12 @@ OpenGemini is an open-source time series database, find more about OpenGemini at
 
 ## Usage
 
-Import the client library:
+Import the Client Library:
+
+<i><font color=gray>The example code use the dot import, but the user should choose the package import method according to their own needs</font></i>
 
 ```go
-import . "github.com/openGemini/opengemini-client-go"
+import . "github.com/openGemini/opengemini-client-go/opengemini"
 ```
 
 Create a Client:
@@ -43,7 +45,7 @@ Create a Database:
 	}
 ```
 
-Write a single point:
+Write single point:
 
 ```go
 	exampleMeasurement := "ExampleMeasurement"

diff --git a/examples/example/example.go b/examples/example/example.go
@@ -1,5 +1,9 @@
 package main
 
+/*
+	The example code use the dot import, but the user should choose the package import method according to their own needs
+*/
+
 import (
 	"fmt"
 	. "github.com/openGemini/opengemini-client-go/opengemini"