search

rust-syndication / rss

Library for serializing the RSS web content syndication format
https://crates.io/crates/rss
Apache License 2.0
419 stars 52 forks source link

Update readme to match lib doc #48

Closed chrisppy closed 7 years ago

jameshurst commented 7 years ago

I think the README should provide a brief overview of the library and explanation of what it does, and for detailed usage information that's what the documentation is for. For this reason I'm inclined to say the README is fine as is. What do you think @frewsxcv?

tafia commented 7 years ago

I too prefer having the readme very similar to the crate top module documentation.

jameshurst commented 7 years ago

Fair enough, that's good with me then.

frewsxcv commented 7 years ago

This is great, thanks!