| @@ -2,12 +2,12 @@ | |||||
| [](https://travis-ci.org/witochandra/webfeed) | [](https://travis-ci.org/witochandra/webfeed) | ||||
| A dart package for parsing RSS feed. | |||||
| A dart package for parsing RSS and Atom feed. | |||||
| ### Features | ### Features | ||||
| - [x] RSS | - [x] RSS | ||||
| - [ ] Atom | |||||
| - [x] Atom | |||||
| - [ ] JSON | - [ ] JSON | ||||
| ### Installing | ### Installing | ||||
| @@ -19,14 +19,16 @@ webfeed: ^0.1.0 | |||||
| Import the package into your dart code using: | Import the package into your dart code using: | ||||
| ``` | ``` | ||||
| import 'package:webfeed/domain/rss_feed.dart'; | |||||
| import 'package:webfeed/domain/rss_feed.dart'; // for parsing RSS feed | |||||
| import 'package:webfeed/domain/atom_feed.dart'; // for parsing Atom feed | |||||
| ``` | ``` | ||||
| ### Example | ### Example | ||||
| To parse string into `RssFeed` object use: | To parse string into `RssFeed` object use: | ||||
| ``` | ``` | ||||
| new RssFeed.parse(xmlString); | |||||
| var rssFeed = new RssFeed.parse(xmlString); // for parsing RSS feed | |||||
| var atomFeed = new AtomFeed.parse(xmlString); // for parsing Atom feed | |||||
| ``` | ``` | ||||
| ### Preview | ### Preview | ||||
| @@ -64,6 +66,37 @@ item.comments | |||||
| item.source | item.source | ||||
| ``` | ``` | ||||
| **Atom** | |||||
| ``` | |||||
| feed.id | |||||
| feed.title | |||||
| feed.updated | |||||
| feed.items | |||||
| feed.links | |||||
| feed.authors | |||||
| feed.contributors | |||||
| feed.categories | |||||
| feed.generator | |||||
| feed.icon | |||||
| feed.logo | |||||
| feed.rights | |||||
| feed.subtitle | |||||
| AtomItem item = feed.items.first; | |||||
| item.id | |||||
| item.title | |||||
| item.updated | |||||
| item.authors | |||||
| item.links | |||||
| item.categories | |||||
| item.contributors | |||||
| item.source | |||||
| item.published | |||||
| item.content | |||||
| item.summary | |||||
| item.rights | |||||
| ``` | |||||
| ## License | ## License | ||||
| WebFeed is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details | WebFeed is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details | ||||