aboutsummaryrefslogtreecommitdiffhomepage
path: root/vendor/github.com/miniflux/miniflux-go/README.md
blob: d1b5cda40ab08718ed39f47940a2c2b158fc4107 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
Go Library for Miniflux
=======================
[![Build Status](https://travis-ci.org/miniflux/miniflux-go.svg?branch=master)](https://travis-ci.org/miniflux/miniflux-go)
[![GoDoc](https://godoc.org/github.com/miniflux/miniflux-go?status.svg)](https://godoc.org/github.com/miniflux/miniflux-go)

Client library for Miniflux REST API.

Requirements
------------

- Miniflux >= 2.0.0
- Go >= 1.9

Installation
------------

```bash
go get -u github.com/miniflux/miniflux-go
```

Example
-------

```go
package main

import (
	"fmt"

	"github.com/miniflux/miniflux-go"
)

func main() {
    client := miniflux.NewClient("https://api.example.org", "admin", "secret")

    // Fetch all feeds.
    feeds, err := client.Feeds()
    if err != nil {
        fmt.Println(err)
        return
    }
    fmt.Println(feeds)

    // Backup to opml file.
    opml, err := client.Export()
    if err != nil {
        fmt.Println(err)
        return
    }

    err = ioutil.WriteFile("opml.xml", opml, 0644)
    if err != nil {
        fmt.Println(err)
        return
    }
    fmt.Println("backup done!")

}
```

Credits
-------

- Author: Frédéric Guillot
- Distributed under MIT License