Merge branch 'tiny-oop'

[tt-rss.git] / README

diff --git a/README b/README
index 2bea749b5cb2c109494a27278d9dd7edf014898a..1352f9c70185cff40df41cd277ba5b72995425d9 100644 (file)
--- a/README
+++ b/README
@@ -1,22 +1,36 @@
 Tiny Tiny RSS
 =============
 
-Server-side RSS feed aggregator written in PHP and heavily based
-on XmlHttpRequest and related technologies for user interface and
-operation.
+Web-based news feed aggregator, designed to allow you to read news from 
+any location, while feeling as close to a real desktop application as possible.
 
-Licensed under GPL version 2.
+http://tt-rss.org
 
-Warning: This is alpha quality experimental code.
+Licensed under GNU GPL version 2
 
-Requirements:
-       
-       - Magpie RSS (http://magpierss.sourceforge.net/) - place it into
-         magpierss/ subdirectory;
-       - PostgreSQL (example schema and configuration in ttrss_schema.sql)
+Copyright (c) 2005-2010 Andrew Dolgov (unless explicitly stated otherwise).
 
-Don't forget to copy config.php-dist to config.php and edit it.
+Requirements
+============
 
-icons/ directory should be writable for your httpd user.
+       * Compatible web browser (http://tt-rss.org/wiki/CompatibleBrowsers)
+       * Web server, for example Apache
+       * PHP (with support for mbstring functions)
+       * PostgreSQL (tested on 8.3) or MySQL (InnoDB and version 4.1+ required)
+               
+Installation Notes
+==================
 
-Send your questions, comments, patches to Andrew Dolgov <cthulhoo@gmail.com>
+       http://tt-rss.org/wiki/InstallationNotes
+
+See also
+========
+
+       * FAQ:                          http://tt-rss.org/wiki/FrequentlyAskedQuestions
+       * Forum:                                http://tt-rss.org/forum
+       * Wiki:                         http://tt-rss.org/wiki/WikiStart
+
+Contact
+=======
+
+Send your questions, comments, patches to Andrew Dolgov <cthulhoo(at)gmail.com>