Add more examples

README.md

@@ -4,3 +4,54 @@
 [![rss on Crates.io](https://meritbadge.herokuapp.com/rss)](https://crates.io/crates/rss)
 
 [Documentation](https://frewsxcv.github.io/rust-rss/)
+
+## Examples
+
+### Writing
+
+```rust
+use rss::{Channel, Item, Rss};
+
+let item = Item {
+    title: Some(String::from("Ford hires Elon Musk as CEO")),
+    pub_date: Some(String::from("01 Apr 2019 07:30:00 GMT")),
+    description: Some(String::from("In an unprecedented move, Ford hires Elon Musk.")),
+    ..Default::default()
+};
+
+let channel = Channel {
+    title: String::from("TechCrunch"),
+    link: String::from("http://techcrunch.com"),
+    description: String::from("The latest technology news and information on startups"),
+    items: vec![item],
+    ..Default::default()
+};
+
+let rss = Rss(channel);
+
+let rss_string = rss.to_string();
+```
+
+### Reading
+
+```rust
+use rss::Rss;
+
+let rss_str = r#"
+<?xml version="1.0" encoding="UTF-8"?>
+<rss version="2.0">
+  <channel>
+    <title>Public weblog for Pinboard</title>
+    <link>http://techcrunch.com</link>
+    <description>The latest technology news and information on startups</description>
+    <item>
+      <title>Ford hires Elon Musk as CEO</title>
+      <pubDate>01 Apr 2019 07:30:00 GMT</pubDate>
+      <description>In an unprecedented move, Ford hires Elon Musk.</description>
+    </item>
+  </channel>
+</rss>
+"#;
+
+let rss = Rss::from_reader(&mut rss_str.as_bytes()).unwrap();
+```

src/item.rs

@@ -5,6 +5,18 @@ use ::{Category, ElementUtils, ViaXml};
 
 /// [RSS 2.0 Specification § Elements of `<item>`]
 /// (http://cyber.law.harvard.edu/rss/rss.html#hrelementsOfLtitemgt)
+///
+/// # Examples
+///
+/// ```
+/// use rss::Item;
+///
+/// let item = Item {
+///     title: Some(String::from("A blog post title")),
+///     description: Some(String::from("This is a description of the blog post")),
+///     ..Default::default()
+/// };
+/// ```
 #[derive(Default)]
 pub struct Item {
     pub title: Option<String>,

src/lib.rs

@@ -12,6 +12,57 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+//! # Examples
+//!
+//! ## Writing
+//!
+//! ```
+//! use rss::{Channel, Item, Rss};
+//!
+//! let item = Item {
+//!     title: Some(String::from("Ford hires Elon Musk as CEO")),
+//!     pub_date: Some(String::from("01 Apr 2019 07:30:00 GMT")),
+//!     description: Some(String::from("In an unprecedented move, Ford hires Elon Musk.")),
+//!     ..Default::default()
+//! };
+//!
+//! let channel = Channel {
+//!     title: String::from("TechCrunch"),
+//!     link: String::from("http://techcrunch.com"),
+//!     description: String::from("The latest technology news and information on startups"),
+//!     items: vec![item],
+//!     ..Default::default()
+//! };
+//!
+//! let rss = Rss(channel);
+//!
+//! let rss_string = rss.to_string();
+//! ```
+//!
+//! ## Reading
+//!
+//! ```
+//! use rss::Rss;
+//!
+//! let rss_str = r#"
+//! <?xml version="1.0" encoding="UTF-8"?>
+//! <rss version="2.0">
+//!   <channel>
+//!     <title>Public weblog for Pinboard</title>
+//!     <link>http://techcrunch.com</link>
+//!     <description>The latest technology news and information on startups</description>
+//!     <item>
+//!       <title>Ford hires Elon Musk as CEO</title>
+//!       <pubDate>01 Apr 2019 07:30:00 GMT</pubDate>
+//!       <description>In an unprecedented move, Ford hires Elon Musk.</description>
+//!     </item>
+//!   </channel>
+//! </rss>
+//! "#;
+//!
+//! let rss = Rss::from_reader(&mut rss_str.as_bytes()).unwrap();
+//! ```
+
 mod category;
 mod channel;
 mod item;