Filled README and HISTORY

2 files changed, 190 insertions, 4 deletions

diff --git a/HISTORY b/HISTORY
index 11f4945..2c3cca6 100644
--- a/HISTORY
+++ b/HISTORY
@@ -1,6 +1,59 @@
 VDR Plugin 'upnp' Revision History
 ----------------------------------
 
-2012-07-30: Version 0.0.1
+2012-10-24: Version 1.0.0
+
+ - New: Plug-ins for providing access to live-TV and recordings instead of
+        integrated functions. This makes it easier to replace them. Additionally,
+        new plug-ins may be integrated very easily.
+ - New: The VDR plug-in live may be used for presentation home page.
+ - New: The VDR plug-in streamdev is now used for live-TV. (via extern remux)
+ - New: Tntnet is now used instead of the internal web server of libupnp. This
+        enables the plugin to set HTTP headers without patching libupnp.
+ - New: Live-TV channel icons are displayed as thumbnails in the folder preview.
+ - New: Removed the requirement of FFMPEG in the basic plugins (live-TV and
+        recordings). The plugin now uses only features of the VDR to detect
+        the correct stream type of recordings.
+ - New: Seeking is now finally possible on some devices (I have only tested
+        Samsung TV-sets, yet). In this first attempt, it will use byte based
+        seeks. Further attempts to improve it may be required.
+ - New: Full rewrite of the rest of the plugin to reduce memory leaks as much
+        as possible to me.
+
+2009-01-25: Version 0.0.2-alpha1
+
+ - Bug: A minor bug prevented the plugin from detecting the resources
+        correnctly
+
+2009-01-24: Version 0.0.2-alpha0
+
+ - New: Added record streaming support for SDTV
+        HDTV is not working yet, as it requires different DLNA profiles
+ - Bug: Improved live-tv streaming quality, which will hopefully fix the
+        problem with the buffer strategy and channels with bad bandwidth
+ - New: Rearranged folder structure to meet future features
+ - New: Added german translation
+ - New: support for DLNA compatible devices. For those devices a special
+        patch is required which must be applied to libupnp-1.6.6.
+        See README for more information
+ - New: Added new command line option to specify the destination folder
+        for the metadata database and the webfolder.
+        See README for more information
+
+2009-11-19: Version 0.0.1-alpha4
+
+- New: Added options for verbosity level and autodetect settings.
+
+2009-10-23: Version 0.0.1-alpha1
+
+- Fixed #185: Database rejected statements with single quotes inside strings
+
+2009-10-23: Version 0.0.1-alpha0
 
 - Initial revision.
+- Known limitations: currently only channel lists with less than 30 channels
+  work.
+- LiveTV support
+- Limited sort capabilities: Title, Creator, Write status, Publisher,
+  Description, Long description, Genre
+  Note: Sort will only work if this properties are present
diff --git a/README b/README
index 241fe06..f8bab25 100644
--- a/README
+++ b/README
@@ -1,10 +1,11 @@
 This is a "plugin" for the Video Disk Recorder (VDR).
 
-Written by:                  Your Name <email@host.dom>
+Written by:                  Denis Loh <denis.loh@hftl.de>
+                             Andreas Günther <andreas.guenther@hftl.de>
 
-Project's homepage:          URL
+Project's homepage:          http://upnp.vdr-developer.org
 
-Latest version available at: URL
+Latest version available at: http://upnp.vdr-developer.org
 
 This program is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
@@ -12,4 +13,136 @@ the Free Software Foundation; either version 2 of the License, or
 (at your option) any later version.
 See the file COPYING for more information.
 
+Please note: This plugin is written under the terms of open source
+redistribution by
+
+Hochschule für Telekommunikation Leipzig,
+University of Applied Science
+Gustav-Freytag-Straße 43-45
+04277 Leipzig
+Germany
+http://www.hft-leipzig.de
+
+All rights reserved.
+
+Contents:
+
+1 Description
+2 Dependencies
+3 Patching libupnp
+4 Firewall
+
 Description:
+
+UPnP/DLNA Plugin for Video Disk Recorder
+
+This Plugins extends the VDR with the possibility to act as an UPnP/DLNA Media
+Server (DMS). It will serve VDR's contents in the network to any UPnP-AV and
+DLNA capable devices.
+
+The plugin requires a valid network connection with a IPv4 address. It will find
+its settings automatically by default. In this case, the first network device in
+the network device list with a valid IPv4 address and port 49152 will be used
+for connections. You can change this behavior either by setting the command line
+options or by editing the setup via the VDRs setup page. The command line
+options have a higher priority and substitute the menu settings.
+
+The command line settings are:
+  -i <interface>  --int=<interface>     The server network
+                                        interface
+                                        e.g: eth0, wlan1 etc.
+                                        If given option '-a' must
+                                        be absent.
+  -a <address>    --address=<address>   The server IPv4 address.
+                                        If given option '-i' must
+                                        be absent.
+  -p <port>       --port=<port>         The server port
+                                        Supported ports:
+                                        0           (auto detect)
+                                        49152-65535 (user defined)
+  -d              --autodetect          Force auto detection
+                                        Use this option to
+                                        overwrite the setup menu
+                                        options.
+  -v              --verbose             Increase verbosity level
+                                        The more v options the
+                                        higher the output level
+                  --dbdir=<directory>   The directory in which the
+                                        metadata database is stored
+                  --httpdir=<directory> The directory where the
+                                        http documents are located
+
+The verbose option can be more than once. With each option the verbosity level
+will be increased. The maximum level is 5. Further options are silently ignored.
+
+  -v                                  Print most important messages
+  -vv                                 Print messages from the components
+                                      i.e. the webserver, CDS, CMS, etc.
+  -vvv                                Print messages from receivers and players
+                                      and other additional components
+  -vvvv                               You can't get enough, hum?
+                                      This will print SQL messages and DIDL
+                                      messages
+  -vvvvv                              Can you read the matrix? You can't?
+                                      Then try first reading SQL statements,
+                                      fetches, buffer and parser outputs or
+                                      any other outputs.
+
+If not options are set, menu options will be used.
+
+The server has a unique identifier, which is
+"uuid:b120ba52-d88d-4500-9b64-888971d83fd3". Other devices in the network can
+find and identify the VDR UPnP Server with this ID. However, the server should
+be found automatically and being listed under the supported media server
+devices. If not, please report this as a bug on the project homepage or send an
+email to the developers of this plugin with the full device description and, if
+applicable, the errors thrown by the media player device and/or the server.
+
+
+Dependencies:
+
+This plugin is tested with and requires the following libraries to work:
+
+libupnp-1.6.6               The UPnP SDK
+libsqlite-3.6               SQLite 3 Database
+libavcodec-svn20090303      FFMPEG Library for analyzing audio video codecs
+libavformat-svn20090303     FFMPEG Library for analyzing audio video formats
+boost::spirit               Grammar parser
+boost::function             Boost function library
+boost::bind                 Boost bind library
+
+The boost libraries are usually available in a packed version, so that only a
+single installation is required. The FFMPEG libraries comes with FFMPEG itself.
+
+ATTENTION: DO NOT USE ANOTHER VERSION OF LIBUPNP.
+
+libupnp-1.8.0 is known not to work with this plugin! Versions below 1.6.6 may
+work. However, there may exist some unknown issues.
+
+If you want to know everything about the code, please see the source code
+documentation at http://upnp.vdr-developer.org/docs/ where all public members
+are explained.
+
+I appreciate, if you help making the plugin better. If you find any project
+related errors or missing features, please open a new ticket at the plugin
+website with a detailed description of what you want or what happened.
+
+
+Patching the libupnp:
+
+If you have a DLNA compliant device such as TVs or streaming clients, you may
+require a patched version of libupnp. You can download the patch on the project
+website.
+
+Firewall:
+
+If you want to use the plugin behind a firewall, then you need to open the
+following ports:
+
+1900            UDP     SSDP (Simple Service Discorvery Protocol)
+2869            TCP     SSDP (Simple Service Discorvery Protocol)
+User defined    TCP     Data
+
+The user defined port may be set automatically by the server or by the user via
+the setup or command line options. You need to accept multicast messages from
+239.255.255.250, which is used by SSDP to discover other UPnP devices.