move update_rss_feed transaction lock after $rss validity check

[tt-rss.git] / README

diff --git a/README b/README
index 7d1b4f7f7284b89e6b0c1a16277063579fa68bc6..f93cf6c83b78b238829fe74914085618e3b2487a 100644 (file)
--- a/README
+++ b/README
@@ -7,15 +7,42 @@ operation.
 
 Licensed under GPL version 2.
 
-Warning: This is alpha quality experimental code.
+Warning: I don't know how to stress it enough - please do not install
+this program wide open to the whole internet. It belongs to (host or password)
+protected directory on your webserver. There could be SQL-injection or other
+remote vulnerabilities, so beware.
+
+Version 1.1 adds experimental support for multi-user operation, disable option
+SINGLE_USER_MODE to access it. Default user is "admin" with password "password",
+don't forget to change it.
+
+Interface:
+
+       There is (incomplete) support for keyboard navigation.
+       
+       "n" and "p" moves between next/previous posts when feed is opened;
+       "r" refreshes feed list;
+       "u" refreshes currently selected feed;
+       "a" hides or shows only unread feeds in the feedlist;
 
 Requirements:
        
-       - PHP4;
        - Magpie RSS (http://magpierss.sourceforge.net/) - place it into
          magpierss/ subdirectory;
-       - PostgreSQL (example schema and configuration in ttrss_schema.sql)
+         
+       - RDBMS backend:
+       
+                       a) PostgreSQL
+                       
+                       b) MySQL (InnoDB and server version 4.1+ required)
+
+         Example DB schemas and configuration are in schema/ subdirectory.
+         
+         For PostgreSQL don't forget to create database with UTF-8 encoding
+         (createdb -E UTF-8 -O owner_user database).
 
 Don't forget to copy config.php-dist to config.php and edit it.
 
+icons/ directory should be writable for your httpd user.
+
 Send your questions, comments, patches to Andrew Dolgov <cthulhoo@gmail.com>