Prepare for release.

[git-p4: depot-paths = "//src/UPnP-ContentDirectory/dev/": change = 4072]

History.txt

@@ -1,6 +1,5 @@
-=== 1.0.0 / 2008-07-13
+=== 1.0.0 / 2008-07-23
 
 * 1 major enhancement
-
   * Birthday!
 

README.txt

@@ -1,48 +1,83 @@
 = UPnP-ContentDirectory
 
-* FIX (url)
+* http://seattlerb.org/UPnP-ContentDirectory
+* http://upnp.org
+* Bugs: http://rubyforge.org/tracker/?func=add&group_id=1513&atid=5921
 
 == DESCRIPTION:
 
-FIX (describe your package)
+A UPnP ContentDirectory service with some DLNA extensions.  Currently this is
+a work in progress, and is only adequate for viewing images on a PlayStation
+3.
 
 == FEATURES/PROBLEMS:
 
-* FIX (list of features or problems)
+* Only direct filesystem representations currently supported
+* Largely undocumented
+* Only tested on PlayStation 3
+* Only images known to work
+* Partially implemented:
+  * Browse
+  * GetSystemUpdateID
+* Not implemented:
+  * CreateObject
+  * CreateReference
+  * DeleteResource
+  * DestroyObject
+  * ExportResource
+  * GetSearchCapabilities
+  * GetSortCapabilities
+  * GetTransferProgress
+  * ImportResource
+  * Search
+  * StopTransferResource
+  * UpdateObject
 
 == SYNOPSIS:
 
-  FIX (code sample of usage)
+In a UPnP::Device::create block:
+
+  your_device.add_service 'ContentDirectory' do |cd|
+    cd.add_directory Dir.pwd
+  end
+
+See UPnP::Device::MediaServer for an example of usage.
 
 == REQUIREMENTS:
 
-* FIX (list of requirements)
+* A filesystem with files on it
+* A UPnP MediaServer control point
 
 == INSTALL:
 
-* FIX (sudo gem install, anything else)
+  sudo gem install UPnP-ContentDirectory
 
 == LICENSE:
 
-(The MIT License)
-
-Copyright (c) 2008 FIX
-
-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.
+Copyright 2008 Eric Hodel.  All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+
+1. Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright
+   notice, this list of conditions and the following disclaimer in the
+   documentation and/or other materials provided with the distribution.
+3. Neither the names of the authors nor the names of their contributors
+   may be used to endorse or promote products derived from this software
+   without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS
+OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
+OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
+OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
+BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
-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.

lib/UPnP/service/content_directory.rb

@@ -4,6 +4,9 @@
 require 'rubygems'
 require 'UPnP/service'
 
+##
+# A UPnP ContentDirectory service.  See upnp.org for specifications.
+
 class UPnP::Service::ContentDirectory < UPnP::Service
 
   VERSION = '1.0'