oss/miniflux-v2
oss/miniflux-v2
1
0
Fork 0
mirror of https://github.com/miniflux/v2.git synced 2025-06-27 16:36:00 +00:00
Code Wiki Activity

docs: update client README to not reference deprecated function

Browse source
This commit is contained in:
David Pedersen 2025-02-28 08:52:08 +07:00 • committed by GitHub
parent d7c504f48e
commit 86b3593fec
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 3 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

4
client/README.md
View file

@ -27,10 +27,10 @@ import (
func main() { func main() {
// Authentication with username/password: // 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: // 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. // Fetch all feeds.
feeds, err := client.Feeds() feeds, err := client.Feeds()

1
client/client.go
View file

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