add documents

Author: micheam

README.md

@@ -0,0 +1,89 @@
+# go-deeplapi
+
+## Usage
+
+### AS CLI TOOL
+
+```sh
+$ go install github.com/micheam/go-deeplapi/cmd/translate@latest
+```
+
+```sh
+$ translate こんにちわ、世界
+Hello, World
+```
+
+Please run `-help` for detailed usage.
+
+```
+$ translate -help
+Usage of translate:
+  translate [flags] [text]
+Flags:
+  --api-domain string
+  	Domain for DeepL API. (Default) Environment variable: 'DEEPL_API_DOMAIN'
+  	Use 'api.deepl.com' if not set.
+  --auth-key string
+  	Authentication Key for DeepL API. (Default) Environment variable: 'DEEPL_AUTH_KEY'
+  --list-lang
+  	Display a list of LANG_CODE that can be specified.
+  --source string
+  	LANG_CODE of the text to be translated. If it is omitted, it will be determined automatically.
+  --target string
+  	LANG_CODE of the text to be translated. (default 'EN')
+Examples:
+  $ translate --soruce ja --taget en 'あんなこといいな。できたらいいな'
+  $ echo 'あんなこといいな。できたらいいな' | translate # source lang will auto-detected
+```
+
+### AS GO MODULE
+
+```sh
+$ go get github.com/micheam/go-deeplapi/v2
+```
+
+```go
+package main
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/micheam/go-deeplapi/v2"
+)
+
+func main() {
+
+	const authKey = "YOUR-DEEPL-AUTH-KEY"
+	client := deeplapi.New(authKey)
+	service := deeplapi.NewTextTranslatingService(client)
+
+	var (
+		text   = "こんにちわ、世界"
+		source = deeplapi.LangJapanese
+		target = deeplapi.LangEnglish
+	)
+
+	res, _ := service.TraslateSingleText(context.Background(), text, source, target)
+	fmt.Println(res.Text)
+	// Output: Hello, World
+}
+```
+
+## Requirements
+
+- go 1.19 or higher
+
+## Installation
+
+```sh
+$ go install github.com/micheam/go-deeplapi/cmd/translate
+```
+
+## License
+
+MIT
+
+## Author
+
+[Michito Maeda](https://github.com/micheam)

example/go.mod

@@ -0,0 +1,7 @@
+module github.com/micheam/go-deeplapi/example
+
+go 1.19
+
+replace github.com/micheam/go-deeplapi => ../
+
+require github.com/micheam/go-deeplapi v0.0.0-00010101000000-000000000000

example/go.sum

@@ -0,0 +1,25 @@
+package main
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/micheam/go-deeplapi/v2"
+)
+
+func main() {
+
+	const authKey = "YOUR-DEEPL-AUTH-KEY"
+	client := deeplapi.New(authKey)
+	service := deeplapi.NewTextTranslatingService(client)
+
+	var (
+		text   = "こんにちわ、世界"
+		source = deeplapi.LangJapanese
+		target = deeplapi.LangEnglish
+	)
+
+	res, _ := service.TraslateSingleText(context.Background(), text, source, target)
+	fmt.Println(res.Text)
+	// Output: Hello, World
+}

example/main.go

@@ -1,3 +1,3 @@
 module github.com/micheam/go-deeplapi
 
-go 1.16
+go 1.19

go.mod

@@ -4,6 +4,7 @@ import (
 	"context"
 	"encoding/json"
 	"fmt"
+	"log"
 	"net/http"
 	"net/url"
 	"strings"
@@ -110,6 +111,7 @@ type TraslateSingleTextResult struct {
 }
 
 func (t TextTranslatingService) TraslateSingleText(ctx context.Context, text string, source, target Lang) (*TraslateSingleTextResult, error) {
+	log.Println("base url: " + BaseURL())
 	_url := strings.Join([]string{BaseURL(), APIVersion, PathTextTranslating}, "/")
 	param := url.Values{
 		"text":        []string{text},