rome/README.md

# ROME

[![Build Status](https://travis-ci.org/rometools/rome.svg?branch=master)](https://travis-ci.org/rometools/rome)
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.rometools/rome/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.rometools/rome)

ROME is a Java framework for RSS and Atom feeds. The framework consist of several modules:

| Module | Description |
| ------ | ----------- |
| rome | is the main RSS and Atom library. It makes it easy to work with most syndication formats: RSS 0.90, RSS 0.91 Netscape, RSS 0.91 Userland, RSS 0.92, RSS 0.93, RSS 0.94, RSS 1.0, RSS 2.0, Atom 0.3, Atom 1.0. |
| rome-modules| enables rome to handle several feed extensions like MediaRSS, GeoRSS and others. |
| rome-opml | contains [OPML](https://en.wikipedia.org/wiki/OPML) parsers and tools. |

Deprecated modules: `rome-fetcher`, `rome-certiorem`, `rome-certiorem-webapp` and `rome-propono`.

## Changelog

### 1.6.0

- [Upgrade of JDOM to version 2.0.5](https://github.com/rometools/rome/issues/197)
- [Maven plugin and dependency updates](https://github.com/rometools/rome/issues/268)
- [Support for allowing Doctype declarations in rome-fetcher](https://github.com/rometools/rome/issues/234)
- [OSGi improvements](https://github.com/rometools/rome/issues/143) 

### 1.5.1

- solved an [XML bomb](https://en.wikipedia.org/wiki/Billion_laughs) vulnerability

Important note: due to the security fix ROME now forbids all Doctype declarations by default. This will break compatibility with RSS 0.91 Netscape
because it requires a Doctype declaration. When you experience problems you have to activate the property **allowDoctypes** on the SyndFeedInput object. You 
should only use this possibility when the feeds that you process are absolutely trustful.

### 1.5.0

- many (untracked) enhancements
- code cleanup
- renamed packages (was required to be able to push to Maven Central after years again)
- updated sourcecode to Java 1.6

### Prior to 1.5.0

- see [http://rometools.github.io/rome/ROMEReleases](http://rometools.github.io/rome/ROMEReleases)
Added changelog for version 1.6.0 2016-03-04 23:56:45 +01:00			`# ROME`

Add build status badge to readme 2016-07-18 15:41:10 +02:00			`[![Build Status](https://travis-ci.org/rometools/rome.svg?branch=master)](https://travis-ci.org/rometools/rome)`
Added changelog for version 1.6.0 2016-03-04 23:56:45 +01:00			`[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.rometools/rome/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.rometools/rome)`

			`ROME is a Java framework for RSS and Atom feeds. The framework consist of several modules:`

			`\| Module \| Description \|`
			`\| ------ \| ----------- \|`
			`\| rome \| is the main RSS and Atom library. It makes it easy to work with most syndication formats: RSS 0.90, RSS 0.91 Netscape, RSS 0.91 Userland, RSS 0.92, RSS 0.93, RSS 0.94, RSS 1.0, RSS 2.0, Atom 0.3, Atom 1.0. \|`
			`\| rome-modules\| enables rome to handle several feed extensions like MediaRSS, GeoRSS and others. \|`
			`\| rome-opml \| contains [OPML](https://en.wikipedia.org/wiki/OPML) parsers and tools. \|`
List deprecated modules in readme No need for detailed description of modules that are deprecated and will be removed soon anyway. 2016-10-10 22:20:11 +02:00
			Deprecated modules: `rome-fetcher`, `rome-certiorem`, `rome-certiorem-webapp` and `rome-propono`.
Added changelog for version 1.6.0 2016-03-04 23:56:45 +01:00
			`## Changelog`

			`### 1.6.0`

			`- [Upgrade of JDOM to version 2.0.5](https://github.com/rometools/rome/issues/197)`
			`- [Maven plugin and dependency updates](https://github.com/rometools/rome/issues/268)`
			`- [Support for allowing Doctype declarations in rome-fetcher](https://github.com/rometools/rome/issues/234)`
			`- [OSGi improvements](https://github.com/rometools/rome/issues/143)`

			`### 1.5.1`

			`- solved an [XML bomb](https://en.wikipedia.org/wiki/Billion_laughs) vulnerability`

			`Important note: due to the security fix ROME now forbids all Doctype declarations by default. This will break compatibility with RSS 0.91 Netscape`
			`because it requires a Doctype declaration. When you experience problems you have to activate the property allowDoctypes on the SyndFeedInput object. You`
			`should only use this possibility when the feeds that you process are absolutely trustful.`

			`### 1.5.0`

			`- many (untracked) enhancements`
			`- code cleanup`
			`- renamed packages (was required to be able to push to Maven Central after years again)`
			`- updated sourcecode to Java 1.6`

			`### Prior to 1.5.0`

			`- see [http://rometools.github.io/rome/ROMEReleases](http://rometools.github.io/rome/ROMEReleases)`