do not show headers when there are no headers

[enigma2-curlytx.git] / README.rst

diff --git a/README.rst b/README.rst
index f497390ab7b89769edb1ed7856313fea9069a0f9..aefa18c2990bfcf2b399acfcec0b1ae1c0bca5d4 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -18,6 +18,7 @@ Features
 - Reload pages
 - Show HTTP headers
 - Configurable page titles
+- Configurable text size
 - Configurable default page
 - Import complete page list from Atom feed
 - Visible in the main menu or the extension menu (configurable)
@@ -29,8 +30,63 @@ Features
 Usage
 =====
 
-FIXME
+First run
+=========
+After installing CurlyTx and restarting Enigma2, open the main menu.
+The first entry will be "CurlyTx" - activate it.
 
+You will see the main window with the message
+"Go and add a page in the settings".
+Do just that end press the red button to access the settings window.
+
+Now we'll add the first URL:
+
+- Press the yellow button ("New"); the "page edit" window will show up
+- Enter the page URL, e.g. http://ip.cweiske.de
+- If you wish, enter a page title, e.g. "My IP"
+- Set the text size if you want. 20 is a good default value.
+- Press the green button ("OK"), and you are back on the settings window.
+- The page you have just created is in the configuration list now.
+
+
+If you made a mistake and want to change it, select the page with the
+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.
+
+
+Adding many pages
+=================
+You can use the settings window to add new pages, but this gets tedious if you
+want to add many pages.
+
+It's better to use the Atom feed import in this case.
+All you need is a text editor and a web server you can serve the feed page with.
+
+Here is an example feed::
+
+  <?xml version="1.0" encoding="utf-8"?>
+  <feed xmlns="http://www.w3.org/2005/Atom">
+   <title>URL list for CurlyTx</title>
+   <author>
+    <name>Christian Weiske</name>
+    <email>cweiske@cweiske.de</email>
+   </author>
+   <link rel="self" href="http://cweiske.de/tagebuch/feed/"/>
+   <entry>
+    <id>http://ip.cweiske.de/</id>
+    <title>My IP</title>
+   </entry>
+   <entry>
+    <id>http://home/temperatures.txt</id>
+    <title>House temperatures</title>
+   </entry>
+  </feed>
+
+Start CurlyTx, go to the settings and write the feed URL in the
+"Page feed URL" field.
+Then press "OK" and the feed's pages will be loaded into the settings window.
 
 
 =================