From 3e0c8507a4d79d9ec393a9a0966a91b11085efa5 Mon Sep 17 00:00:00 2001 From: David Pedersen Date: Thu, 27 Feb 2025 13:59:32 +0700 Subject: [PATCH] Update client README to not reference deprecated function --- client/README.md | 4 ++-- client/client.go | 1 + 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/client/README.md b/client/README.md index a10dbffd211..342ad7cef8b 100644 --- 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 index a07c05525a1..838af02e2e1 100644 --- 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...)