# HG changeset patch # User Guido Berhoerster # Date 1413747157 -7200 # Node ID 0203fffb4d745ce98d8ab85e51b7e9ba20235229 # Parent cba4887feb2c4635b7de700988fc34ace4ef0ccf Add README file diff -r cba4887feb2c -r 0203fffb4d74 README --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/README Sun Oct 19 21:32:37 2014 +0200 @@ -0,0 +1,51 @@ +relmon +====== + +Description +----------- + +relmon is a utility for monitoring websites of software projects for new +releases. It crawls websites efficiently via HTTP or HTTPS using a configurable +number of simultaneous connections and can parse HTML and XHTML documents as +well as RSS 2.0 and Atom feeds. Software releases are detected by extracting +the version numbers of links to distribution files from the parsed documents or +feeds. In addition to the version numbers, the history of releases consisting +of the times new release were initially discovered, any encountered errors and +the time this information was last updated are recorded. + +The recorded information on each software project can be output in several +different formats, including formatted text, machine-parseable text, and HTML, +optionally with the history of releases in Atom feed fromat. + +Requirements +------------ + +relmon requires Tcl 8.5 or later, tcllib, tls, and tdom. It has been tested on +Linux distributions and FreeBSD. + +License +------- + +Except otherwise noted, all files are Copyright (C) 2014 Guido Berhoerster and +distributed under the following license terms: + +Copyright (C) 2014 Guido Berhoerster + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be included +in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. +IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, +TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE +SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.