prepare changelog for 1.1.0

[enigma2-curlytx.git] / README.rst

diff --git a/README.rst b/README.rst
index 50f465ba4e2d4d4a3fc219479b1bda67940b14c5..1af6c2d12d7245b4f2fdde3a52748d024a332877 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -56,6 +56,9 @@ up/down buttons and press "OK" - the page edit window will open.
 Press the green button and the settings will be saved.
 You're back on the main window now and the URL you just configured will be loaded.
 
 Press the green button and the settings will be saved.
 You're back on the main window now and the URL you just configured will be loaded.
 

+Note that with version 1.1, CurlyTx supports opening local files.
+Prepend them with ``file://``, e.g. ``file:///tmp/test.txt``.
+

 
 Adding many pages
 =================
 
 Adding many pages
 =================


@@ -92,6 +95,51 @@ Start CurlyTx, go to the settings and write the feed URL in the
 Then press "OK" and the feed's pages will be loaded into the settings window.
 
 
 Then press "OK" and the feed's pages will be loaded into the settings window.
 
 

+Local configuration file
+========================
+CurlyTx looks for a local page feed file on the harddisk on every run,
+at ``/etc/enigma2/curlytx-pagefeed.xml``.
+If this file exists, it gets loaded unconditionally and overwrites
+the current page configuration.
+
+
+Disable settings
+================
+The page feed file may contain a tag that disables the settings button.
+By using it, you can prevent people from modifying the CurlyTx settings.
+
+First, register the namespace::
+
+    <feed xmlns="http://www.w3.org/2005/Atom" xmlns:c="http://ns.cweiske.de/curlytx">
+
+Then, add the setting after the author or self link::
+
+    <c:enableSettings>0</c:enableSettings>
+
+Here is the example feed with disabled settings::
+
+  <?xml version="1.0" encoding="utf-8"?>
+  <feed xmlns="http://www.w3.org/2005/Atom" xmlns:c="http://ns.cweiske.de/curlytx">
+   <title>URL list for CurlyTx</title>
+   <author>
+    <name>Christian Weiske</name>
+    <email>cweiske@cweiske.de</email>
+   </author>
+   <link rel="self" href="http://home.cweiske.de/pagefeed.atom"/>
+   <c:enableSettings>0</c:enableSettings>
+   <entry>
+    <id>ip</id>
+    <title>My IP</title>
+    <link rel="alternate" type="text/html" href="http://ip.cweiske.de/" />
+   </entry>
+   <entry>
+    <id>temp</id>
+    <title>House temperatures</title>
+    <link rel="alternate" type="text/html" href="http://home/temperatures.txt" />
+   </entry>
+  </feed>
+
+

 =================
 Modifying CurlyTx
 =================
 =================
 Modifying CurlyTx
 =================


@@ -173,4 +221,8 @@ License
 =======
 The plugin is subject to the GPLv3_ or later.
 
 =======
 The plugin is subject to the GPLv3_ or later.
 

+Additional exception:
+  This plugin may be distributed and executed on hardware which is licensed by
+  Dream Multimedia GmbH.
+

 .. _GPLv3: http://www.gnu.org/licenses/agpl.html
 .. _GPLv3: http://www.gnu.org/licenses/agpl.html