Mercurial > projects > relmon

comparison README @ 2:0203fffb4d74

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add README file
author Guido Berhoerster <guido+relmon@berhoerster.name>
date Sun, 19 Oct 2014 21:32:37 +0200
parents
children 6d87242c537e
comparison
equal deleted inserted replaced
1:cba4887feb2c 2:0203fffb4d74
1 relmon
2 ======
3
4 Description
5 -----------
6
7 relmon is a utility for monitoring websites of software projects for new
8 releases. It crawls websites efficiently via HTTP or HTTPS using a configurable
9 number of simultaneous connections and can parse HTML and XHTML documents as
10 well as RSS 2.0 and Atom feeds. Software releases are detected by extracting
11 the version numbers of links to distribution files from the parsed documents or
12 feeds. In addition to the version numbers, the history of releases consisting
13 of the times new release were initially discovered, any encountered errors and
14 the time this information was last updated are recorded.
15
16 The recorded information on each software project can be output in several
17 different formats, including formatted text, machine-parseable text, and HTML,
18 optionally with the history of releases in Atom feed fromat.
19
20 Requirements
21 ------------
22
23 relmon requires Tcl 8.5 or later, tcllib, tls, and tdom. It has been tested on
24 Linux distributions and FreeBSD.
25
26 License
27 -------
28
29 Except otherwise noted, all files are Copyright (C) 2014 Guido Berhoerster and
30 distributed under the following license terms:
31
32 Copyright (C) 2014 Guido Berhoerster <guido+relmon@berhoerster.name>
33
34 Permission is hereby granted, free of charge, to any person obtaining
35 a copy of this software and associated documentation files (the
36 "Software"), to deal in the Software without restriction, including
37 without limitation the rights to use, copy, modify, merge, publish,
38 distribute, sublicense, and/or sell copies of the Software, and to
39 permit persons to whom the Software is furnished to do so, subject to
40 the following conditions:
41
42 The above copyright notice and this permission notice shall be included
43 in all copies or substantial portions of the Software.
44
45 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
46 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
47 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
48 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
49 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
50 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
51 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.