Skip to content

Commit 86b3593

Browse files
authored
docs: update client README to not reference deprecated function
1 parent d7c504f commit 86b3593

File tree

2 files changed

+3
-2
lines changed

2 files changed

+3
-2
lines changed

client/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,10 @@ import (
2727

2828
func main() {
2929
// Authentication with username/password:
30-
client := miniflux.New("https://api.example.org", "admin", "secret")
30+
client := miniflux.NewClient("https://api.example.org", "admin", "secret")
3131

3232
// Authentication with an API Key:
33-
client := miniflux.New("https://api.example.org", "my-secret-token")
33+
client := miniflux.NewClient("https://api.example.org", "my-secret-token")
3434

3535
// Fetch all feeds.
3636
feeds, err := client.Feeds()

client/client.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ type Client struct {
1818
}
1919

2020
// New returns a new Miniflux client.
21+
//
2122
// Deprecated: use NewClient instead.
2223
func New(endpoint string, credentials ...string) *Client {
2324
return NewClient(endpoint, credentials...)

0 commit comments

Comments
 (0)