aboutsummaryrefslogtreecommitdiff
path: root/lib/jsonfeed/README.adoc
blob: 581bf3de30dd44fea35a281678835e61081b5a46 (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
= JSON Feed Parser

[link=https://github.com/pwoolcoc/jsonfeed]
image::https://img.shields.io/crates/v/jsonfeed.svg[JSON Feed crate version]

This is a http://jsonfeed.org[JSON Feed] parser in Rust. Just a thin layer on top of `serde`, but it
provides serialization & deserialization, along with a Builder API for constructing feeds.

Note that this is alpha, I still need to add a lot of tests and a couple more features.

== Example

----
extern crate jsonfeed;
extern crate reqwest;

fn main() {
	let resp = reqwest::get("https://example.com/feed.json").unwrap();
	let feed = jsonfeed::from_reader(resp).unwrap();
	println!("Feed title is: {}", feed.title);
}
----

TODO:

* Tests. Lots and lots of tests
* Implement ability to add, serialize, and deserialize custom attributes from the json feed spec