From 87fcf8f942fe28439f206ef1e7b5c1247de930cc Mon Sep 17 00:00:00 2001 From: Patrick Gotthard Date: Sat, 20 Feb 2016 09:28:44 +0100 Subject: [PATCH] Updated README files --- README.md | 39 +++++++++++++++++++++++++++++---- rome-certiorem-webapp/README.md | 7 +++--- rome-certiorem/README | 9 -------- rome-certiorem/README.md | 3 +++ rome-fetcher/README.md | 10 +++------ rome-modules/README.md | 9 +++----- rome-opml/README.md | 9 +++----- rome-propono/README.md | 10 ++++----- rome-utils/README.md | 7 +++--- rome/README.md | 31 ++++---------------------- 10 files changed, 61 insertions(+), 73 deletions(-) delete mode 100644 rome-certiorem/README create mode 100644 rome-certiorem/README.md diff --git a/README.md b/README.md index 716e0ab..2407350 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,35 @@ -rome-parent -=========== - -Parent for all ROME projects +# ROME + +ROME is a Java framework for RSS and Atom feeds. The framework consist of several modules: +| Module | Description | +| ------ | ----------- | +| rome-parent | is the parent project for all ROME modules and contains the common Maven configuration. | +| rome-utils | provides utility classes that are used in several ROME modules. | +| 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. | +| rome-fetcher | is a caching feed fetcher that supports retrieval of feeds via HTTP conditional GET. Supports ETags, GZip compression, and RFC3229 Delta encoding. | +| rome-certiorem | is a [PubSubHubub](https://en.wikipedia.org/wiki/PubSubHubbub) implementation based on rome. | +| rome-certiorem-webapp | is an example webapp for rome-certiorem | +| rome-propono | supports publishing protocols, specifically the Atom Publishing Protocol and the legacy MetaWeblog API. Propono includes an Atom client library, an Atom server framework and a Blog client that supports both Atom protocol and the MetaWeblog API. | + +## Changelog + +### 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) \ No newline at end of file diff --git a/rome-certiorem-webapp/README.md b/rome-certiorem-webapp/README.md index 4679522..e40325f 100644 --- a/rome-certiorem-webapp/README.md +++ b/rome-certiorem-webapp/README.md @@ -1,4 +1,3 @@ -rome-certiorem-webapp -===================== - -Example project using rome-certiorem +# ROME Certiorem WebApp + +An example webapp for rome-certiorem diff --git a/rome-certiorem/README b/rome-certiorem/README deleted file mode 100644 index dc568e4..0000000 --- a/rome-certiorem/README +++ /dev/null @@ -1,9 +0,0 @@ -ROME Certiorem - -Build Instructions -------------------------------------------------------------------------------- - -To build with Maven 2+: - -> mvn package - diff --git a/rome-certiorem/README.md b/rome-certiorem/README.md new file mode 100644 index 0000000..eaabe11 --- /dev/null +++ b/rome-certiorem/README.md @@ -0,0 +1,3 @@ +# ROME Certiorem + +[PubSubHubub](https://en.wikipedia.org/wiki/PubSubHubbub) implementation based on ROME \ No newline at end of file diff --git a/rome-fetcher/README.md b/rome-fetcher/README.md index 49d2dfe..485051c 100644 --- a/rome-fetcher/README.md +++ b/rome-fetcher/README.md @@ -1,7 +1,3 @@ -rome -==== - -ROME is a set of RSS and Atom Utilities for Java. It makes it easy to work in Java 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 - -More Information: http://rometools.github.io/rome-fetcher/ +# ROME Fetcher + +is a caching feed fetcher that supports retrieval of feeds via HTTP conditional GET. Supports ETags, GZip compression, and RFC3229 Delta encoding. \ No newline at end of file diff --git a/rome-modules/README.md b/rome-modules/README.md index 8504b20..e4a85ad 100644 --- a/rome-modules/README.md +++ b/rome-modules/README.md @@ -1,6 +1,3 @@ -rome -==== - -ROME is a set of RSS and Atom Utilities for Java. It makes it easy to work in Java 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 - -More Information: http://rometools.github.io/rome-modules/ +# ROME Modules + +This module contains extensions that enable ROME to handle several feed extensions like MediaRSS, GeoRSS and others \ No newline at end of file diff --git a/rome-opml/README.md b/rome-opml/README.md index 65a6e36..e7f4ceb 100644 --- a/rome-opml/README.md +++ b/rome-opml/README.md @@ -1,6 +1,3 @@ -rome -==== - -ROME is a set of RSS and Atom Utilities for Java. It makes it easy to work in Java 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 - -More Information: http://rometools.github.io/rome-opml/ +# ROME OPML + +This module contains [OPML](https://en.wikipedia.org/wiki/OPML) parsers and tools diff --git a/rome-propono/README.md b/rome-propono/README.md index 8a9f1a5..c23273d 100644 --- a/rome-propono/README.md +++ b/rome-propono/README.md @@ -1,6 +1,4 @@ -rome -==== - -ROME is a set of RSS and Atom Utilities for Java. It makes it easy to work in Java 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 - -More Information: http://rometools.github.io/rome-propono/ +# ROME Propono + +supports publishing protocols, specifically the Atom Publishing Protocol and the legacy MetaWeblog API. Propono includes an Atom client library, an Atom server +framework and a Blog client that supports both Atom protocol and the MetaWeblog API. diff --git a/rome-utils/README.md b/rome-utils/README.md index 18a85fb..2a12184 100644 --- a/rome-utils/README.md +++ b/rome-utils/README.md @@ -1,4 +1,3 @@ -rome-utils -========== - -Utility classes for ROME projects +# ROME Utils + +This modules provides utility classes for all ROME projects diff --git a/rome/README.md b/rome/README.md index b1c6816..b0e9945 100644 --- a/rome/README.md +++ b/rome/README.md @@ -1,27 +1,4 @@ -# ROME - -ROME is a set of RSS and Atom Utilities for Java. It makes it easy to work in Java 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 - -More Information: http://rometools.github.io/rome/ - -## Changelog - -### 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) \ No newline at end of file +# ROME + +ROME is a set of **R**SS and At**om** Utiliti**e**s for Java. 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 \ No newline at end of file