1 files changed, 35 insertions, 0 deletions
diff --git a/client/doc.go b/client/doc.go
new file mode 100644
index 0000000..60d63aa
--- /dev/null
+++ b/client/doc.go
@@ -0,0 +1,35 @@
+// Copyright 2018 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 client implements a client library for the Miniflux REST API.
+
+Examples
+
+This code snippet fetch the list of users:
+
+	import (
+		miniflux "miniflux.app/client"
+	)
+
+	client := miniflux.New("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 client // import "miniflux.app/client"