Bladeren bron

docs: update client README to not reference deprecated function

David Pedersen 1 jaar geleden
bovenliggende
commit
86b3593fec
2 gewijzigde bestanden met toevoegingen van 3 en 2 verwijderingen
  1. 2 2
      client/README.md
  2. 1 0
      client/client.go

+ 2 - 2
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()

+ 1 - 0
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...)