aboutsummaryrefslogtreecommitdiffhomepage
path: root/vendor/github.com/miniflux/miniflux-go/doc.go
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/github.com/miniflux/miniflux-go/doc.go')
-rw-r--r--vendor/github.com/miniflux/miniflux-go/doc.go31
1 files changed, 31 insertions, 0 deletions
diff --git a/vendor/github.com/miniflux/miniflux-go/doc.go b/vendor/github.com/miniflux/miniflux-go/doc.go
new file mode 100644
index 0000000..a878e5f
--- /dev/null
+++ b/vendor/github.com/miniflux/miniflux-go/doc.go
@@ -0,0 +1,31 @@
+// Copyright 2017 Frédéric Guillot. All rights reserved.
+// Use of this source code is governed by the MIT license
+// that can be found in the LICENSE file.
+
+/*
+
+Package miniflux implements a client library for the Miniflux REST API.
+
+Examples
+
+This code snippet fetch the list of users.
+
+ client := miniflux.NewClient("https://api.example.org", "admin", "secret")
+ users, err := client.Users()
+ if err != nil {
+ fmt.Println(err)
+ return
+ }
+ fmt.Println(users, err)
+
+This one discover subscriptions on a website.
+
+ subscriptions, err := client.Discover("https://example.org/")
+ if err != nil {
+ fmt.Println(err)
+ return
+ }
+ fmt.Println(subscriptions)
+
+*/
+package miniflux