-
Notifications
You must be signed in to change notification settings - Fork 0
/
doc.go
18 lines (17 loc) · 1.03 KB
/
doc.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
// package goresourcesync is a simple go library for interacting with resourcesync data.
// The resourcesync protocol is based on the pre-existing sitemap protocol and details can be found:
// http://www.openarchives.org/rs/toc
//
// The motivation for this protocol is easing the discovery of academic research content and providing a
// mechanism for updating those following the feed.
//
// With regards to this small library the motivation is simply making is easy to consume the resourcesync data
// within a Go app.
//
// The library makes no decisions about what to do with content, it does not automatically follow any links within
// the feed. Those decisions are left up to the caller.
//
// While the library does provide a simple Fetcher implementation this is by no means a production ready HTTP Fetcher.
// It is expected that the user of the library will implement their own fetcher either injecting it into the
// ResourceSync object or by fetching the data upfront first and simply calling the Parse function.
package goresourcesync