Update client README to not reference deprecated function

miniflux · Feb 27, 2025 · 3e0c850 · 3e0c850
1 parent d7c504f
commit 3e0c850
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/client/README.md b/client/README.md
@@ -27,10 +27,10 @@ import (
 
 func main() {
     // Authentication with username/password:
-    client := miniflux.New("https://api.example.org", "admin", "secret")
+    client := miniflux.NewClient("https://api.example.org", "admin", "secret")
 
     // Authentication with an API Key:
-    client := miniflux.New("https://api.example.org", "my-secret-token")
+    client := miniflux.NewClient("https://api.example.org", "my-secret-token")
 
     // Fetch all feeds.
     feeds, err := client.Feeds()

diff --git a/client/client.go b/client/client.go
@@ -18,6 +18,7 @@ type Client struct {
 }
 
 // New returns a new Miniflux client.
+//
 // Deprecated: use NewClient instead.
 func New(endpoint string, credentials ...string) *Client {
 	return NewClient(endpoint, credentials...)