only request total counters on initial update request

[tt-rss.git] / README

diff --git a/README b/README
index 4d680668e2ba03a2501ba1988d46ba95cdcfb030..6782e2a0e0431754e60c484a88f75d909648db1d 100644 (file)
--- a/README
+++ b/README
@@ -1,33 +1,78 @@
 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.spb.ru
 
-Warning: This is alpha quality experimental code.
+Copyright (C) 2005 Andrew Dolgov unless stated otherwise.
 
-Interface:
+Portions (C):
 
-       There is (incomplete) support for keyboard navigation.
+       Bob Osola <bobosola@gmail.com> (pngfix.js)
+       Sundar Dorai-Raj <sdoraira@vt.edu> (isNumeric() in functions.js)
 
-       "n" and "p" moves between next/previous posts when feed is opened, switching
-       pages as needed.
+Licensed under GNU GPL version 2
 
-       "r" refreshes feed list
+Features Overview
+=================
 
-       "u" refreshes currently selected feed
+       Updates: http://tt-rss.spb.ru/trac/wiki/FeatureList
 
-Requirements:
-       
-       - Magpie RSS (http://magpierss.sourceforge.net/) - place it into
-         magpierss/ subdirectory;
-       - PostgreSQL (example schema and configuration in ttrss_schema.sql)
+       * Server-side application, user only needs a web browser
+       * Supports RSS, RDF, Atom feeds using Magpie library
+       * Supports OPML import/export
+       * Easy setup and configuration
+       * Streamlined interface using XmlHttpRequest (or AJAX for laypeople)
 
-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 browser on the client side
+
+               Basically, Firefox, Konqueror or MSIE6 are okay. See here
+               for more information:
+
+               http://tt-rss.spb.ru/trac/wiki/CompatibleBrowsers
+
+       * Web server, for example Apache
+       * PHP (requires PHP4 DOMXML extension)
+       * MagpieRSS feed parser (http://magpierss.sourceforge.net/)
+
+       * PostgreSQL (tested on 7.4) or MySQL (InnoDB and version 4.1+ required)
+
+Installation Notes
+==================
+
+       Updates: http://tt-rss.spb.ru/trac/wiki/InstallationNotes
+
+       * If you are upgrading from the previous version, don't forget to update 
+       schema and logout.
+
+       * icons directory should be writable to your httpd user if you plan on 
+       using feed icons
+
+       * Leave DB_HOST empty if you want to connect to database via unix socket
+
+       * For PostgreSQL don't forget to create database with UTF-8 encoding 
+
+                       createdb -E utf-8 -O owner_user database)
+
+       * Don't forget to change your password from default value on your first login
+
+       * Check your config.php for blank lines out of PHP code tags (e.g. 
+       before <? and after ?>), See #1 
+
+See also
+========
+
+       * FAQ:                          http://tt-rss.spb.ru/trac/wiki/FrequentlyAskedQuestions
+       * Forum:                                http://tt-rss.spb.ru/forum
+       * Wiki:                         http://tt-rss.spb.ru/trac/wiki/WikiStart
+       * Bug Tracker:          http://tt-rss.spb.ru/trac/report
+
+Contact
+=======
 
 Send your questions, comments, patches to Andrew Dolgov <cthulhoo@gmail.com>