PatchesAndForks/rome
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Add code examples to readme

Browse source
This commit is contained in:
mishako 2016-10-10 22:58:24 +02:00
parent 3f59e5c7eb
commit cca2fb9a42
1 changed files with 21 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
README.md
View file

@ -12,3 +12,24 @@ ROME is a Java framework for RSS and Atom feeds. The framework consist of severa
| `rome-opml` | [OPML](https://en.wikipedia.org/wiki/OPML) parsers and tools. | | `rome-opml` | [OPML](https://en.wikipedia.org/wiki/OPML) parsers and tools. |
Deprecated modules: `rome-fetcher`, `rome-certiorem`, `rome-certiorem-webapp` and `rome-propono`. Deprecated modules: `rome-fetcher`, `rome-certiorem`, `rome-certiorem-webapp` and `rome-propono`.
## Examples
Parse a feed:
```java
String url = "http://stackoverflow.com/feeds/tag?tagnames=rome";
SyndFeed feed = new SyndFeedInput().build(new XmlReader(new URL(url)));
System.out.println(feed.getTitle());
```
Generate a feed:
```java
SyndFeed feed = new SyndFeedImpl();
feed.setFeedType("rss_2.0");
feed.setTitle("test-title");
feed.setDescription("test-description");
feed.setLink("https://example.org");
System.out.println(new SyndFeedOutput().outputString(feed));
```