Updated README files
This commit is contained in:
Patrick Gotthard
parent
5daf64747a
commit
87fcf8f942
10 changed files with 61 additions and 73 deletions
37
README.md
37
README.md
|
|
@ -1,4 +1,35 @@
|
||||||
rome-parent
|
# ROME
|
||||||
===========
|
|
||||||
|
|
||||||
Parent for all ROME projects
|
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)
|
||||||
|
|
@ -1,4 +1,3 @@
|
||||||
rome-certiorem-webapp
|
# ROME Certiorem WebApp
|
||||||
=====================
|
|
||||||
|
|
||||||
Example project using rome-certiorem
|
An example webapp for rome-certiorem
|
||||||
|
|
|
||||||
|
|
@ -1,9 +0,0 @@
|
||||||
ROME Certiorem
|
|
||||||
|
|
||||||
Build Instructions
|
|
||||||
-------------------------------------------------------------------------------
|
|
||||||
|
|
||||||
To build with Maven 2+:
|
|
||||||
|
|
||||||
> mvn package
|
|
||||||
|
|
||||||
3
rome-certiorem/README.md
Normal file
3
rome-certiorem/README.md
Normal file
|
|
@ -0,0 +1,3 @@
|
||||||
|
# ROME Certiorem
|
||||||
|
|
||||||
|
[PubSubHubub](https://en.wikipedia.org/wiki/PubSubHubbub) implementation based on ROME
|
||||||
|
|
@ -1,7 +1,3 @@
|
||||||
rome
|
# ROME Fetcher
|
||||||
====
|
|
||||||
|
|
||||||
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,
|
is a caching feed fetcher that supports retrieval of feeds via HTTP conditional GET. Supports ETags, GZip compression, and RFC3229 Delta encoding.
|
||||||
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/
|
|
||||||
|
|
@ -1,6 +1,3 @@
|
||||||
rome
|
# ROME Modules
|
||||||
====
|
|
||||||
|
|
||||||
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
|
This module contains extensions that enable ROME to handle several feed extensions like MediaRSS, GeoRSS and others
|
||||||
|
|
||||||
More Information: http://rometools.github.io/rome-modules/
|
|
||||||
|
|
@ -1,6 +1,3 @@
|
||||||
rome
|
# ROME OPML
|
||||||
====
|
|
||||||
|
|
||||||
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
|
This module contains [OPML](https://en.wikipedia.org/wiki/OPML) parsers and tools
|
||||||
|
|
||||||
More Information: http://rometools.github.io/rome-opml/
|
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,4 @@
|
||||||
rome
|
# ROME Propono
|
||||||
====
|
|
||||||
|
|
||||||
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
|
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.
|
||||||
More Information: http://rometools.github.io/rome-propono/
|
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,3 @@
|
||||||
rome-utils
|
# ROME Utils
|
||||||
==========
|
|
||||||
|
|
||||||
Utility classes for ROME projects
|
This modules provides utility classes for all ROME projects
|
||||||
|
|
|
||||||
|
|
@ -1,27 +1,4 @@
|
||||||
# ROME
|
# 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,
|
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
|
||||||
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
|
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)
|
|
||||||
Loading…
Reference in a new issue