From e5c057e2786d80014a0049d3f87eb8fcbbf17cb9 Mon Sep 17 00:00:00 2001 From: PennyYoon <55304072+Chenxulin97@users.noreply.github.com> Date: Mon, 29 Jan 2024 22:27:59 +0800 Subject: [PATCH] docs: add import notice to README and example (#41) Signed-off-by: PennyYoon <525296438@qq.com> --- README.md | 8 +++++--- examples/example/example.go | 4 ++++ 2 files changed, 9 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index d437b4d..ef5b7d8 100644 --- 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: + +The example code use the dot import, but the user should choose the package import method according to their own needs ```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 index 3bdffce..324f77d 100644 --- 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"