projects/relmon

changeset 2:0203fffb4d74

Add README file
author Guido Berhoerster <guido+relmon@berhoerster.name>
date Sun Oct 19 21:32:37 2014 +0200 (2014-10-19)
parents cba4887feb2c
children 6d87242c537e
files README
line diff
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/README	Sun Oct 19 21:32:37 2014 +0200
     1.3 @@ -0,0 +1,51 @@
     1.4 +relmon
     1.5 +======
     1.6 +
     1.7 +Description
     1.8 +-----------
     1.9 +
    1.10 +relmon is a utility for monitoring websites of software projects for new
    1.11 +releases. It crawls websites efficiently via HTTP or HTTPS using a configurable
    1.12 +number of simultaneous connections and can parse HTML and XHTML documents as
    1.13 +well as RSS 2.0 and Atom feeds. Software releases are detected by extracting
    1.14 +the version numbers of links to distribution files from the parsed documents or
    1.15 +feeds. In addition to the version numbers, the history of releases consisting
    1.16 +of the times new release were initially discovered, any encountered errors and
    1.17 +the time this information was last updated are recorded.
    1.18 +
    1.19 +The recorded information on each software project can be output in several
    1.20 +different formats, including formatted text, machine-parseable text, and HTML,
    1.21 +optionally with the history of releases in Atom feed fromat.
    1.22 +
    1.23 +Requirements
    1.24 +------------
    1.25 +
    1.26 +relmon requires Tcl 8.5 or later, tcllib, tls, and tdom. It has been tested on
    1.27 +Linux distributions and FreeBSD.
    1.28 +
    1.29 +License
    1.30 +-------
    1.31 +
    1.32 +Except otherwise noted, all files are Copyright (C) 2014 Guido Berhoerster and
    1.33 +distributed under the following license terms:
    1.34 +
    1.35 +Copyright (C) 2014 Guido Berhoerster <guido+relmon@berhoerster.name>
    1.36 +
    1.37 +Permission is hereby granted, free of charge, to any person obtaining
    1.38 +a copy of this software and associated documentation files (the
    1.39 +"Software"), to deal in the Software without restriction, including
    1.40 +without limitation the rights to use, copy, modify, merge, publish,
    1.41 +distribute, sublicense, and/or sell copies of the Software, and to
    1.42 +permit persons to whom the Software is furnished to do so, subject to
    1.43 +the following conditions:
    1.44 +
    1.45 +The above copyright notice and this permission notice shall be included
    1.46 +in all copies or substantial portions of the Software.
    1.47 +
    1.48 +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
    1.49 +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
    1.50 +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
    1.51 +IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
    1.52 +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
    1.53 +TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
    1.54 +SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.