File	Date	Author	Commit
doc	2014-03-28	mrapp	[38bfe9] Merge with 8c56a420da7d8544456e28c19692e977efeb...
src	2014-03-28	mrapp	[32f8a6] Edited comment.
LICENSE.txt	2013-10-13	mrapp	[ec6ea1] Added license and readme.
README.txt	2014-03-14	mrapp	[642051] Formatted README.txt.
RELEASE_NOTES.txt	2014-03-28	mrapp	[1f8385] Updated release notes.
pom.xml	2014-03-28	mrapp	[8c56a4] Prepared feature release 1.1.0.

Read Me

JavaFeedParserCommon - README
=============================


About
-----

"JavaFeedParserCommon" is a Java-library, which provides common classes and interfaces, which 
can be used by projects, which should allow to parse XML-based news feeds, such like RSS- or 
Atom-feeds. 

The library provides the following features:

	-	To parse and encapsulate XML structures of news feeds from various sources 
		(e.g. from URLs, files etc.) for further processing and presentation.
		
	-	To configure certain behaviors of parsers, which rely on the library to parse 
		news feeds.
	
	-	To log the processing of such feeds via various logging frameworks, using the 
		Simple Logging Facade for Java (SLF4J).

	
License Agreement
-----------------

JavaFeedParserCommon is distributed under the GNU General Public License version 3.0 (GPLv3). 
For further information about this license agreement's content, please refer to its full 
version, which is available via the URL http://www.gnu.org/licenses/gpl-3.0-standalone.html.

The project uses the following third-party-libraries, which are also distributed for free use 
under open source licenses:

	-	The library "JDOM", which is published under an Apache-style open source 
		license, provides a solution for accessing, manipulating, and outputting XML 
		data from Java code.
		
	-	"Simple Logging Facade for Java" (SLF4J) serves a simple facade or abstraction
		for various logging frameworks (e.g. java.util.logging, logback, log4j), 
		allowing the end user to plug in the desired logging framework at deployment 
		time. SLF4J is distributed under the MIT license.
		
Furthermore, the project relies on the following libraries to realize automated unit tests:

	-	The library "JUnit" is a testing framework, which allows to write repeatable 
		tests using Java. The library is available as open source software under the 
		Eclipse Public License (EPL).
		
	-	The JUnit tests are realized, using the library "hamcrest", which provides 
		matcher objects, allowing rules to be defined declaratively. Hamcrest is 
		distributed under the BSD 3-Clause License.
		
	-	For testing the the logging via SLF4J, the logging framework "Logback" is 
		used, which is dual-licensed under the EPL v1.0 and the LGPL 2.1 licenses.


Download
--------

The project homepage of the project "JavaFeedParserCommon" is available on Sourceforge via 
the internet address https://sourceforge.net/projects/javafeedparsercommon.

The latest release of the project can be downloaded as a jar-Archive from the download 
section of the Sourceforge project site mentioned above, which is available via the direct 
link https://sourceforge.net/projects/javafeedparsercommon/files.

As well, the complete source code and documentation is available via a Mercurial repository, 
which can be accessed by the URL ssh://hg.code.sf.net/p/javafeedparsercommon/code.


Building
--------

"JavaFeedParserCommon" is a Maven 3 project. It can be built by executing the following 
command:

	mvn clean package

If the unit tests, which are also shipped together with the project's source code, should be 
run before building, the following command must be used instead:

	mvn clean test package


Contact information
-------------------

For personal feedback or questions you can either contact the developer via his profile on 
Sourceforge, which is available under the direct link https://sourceforge.net/users/mrapp, or 
via the email address michael.rapp90@googlemail.com.