Improve documentation

README.markdown

@@ -1,31 +1,76 @@
 Miniflux - Minimalist News Reader
 =================================
 
-Miniflux is a minimalist web-based news reader. _Less is more_.
+Miniflux is a minimalist and web-based RSS reader.
 
 Features
 --------
 
-- Host anywhere (shared hosting, vps or localhost)
+### Host almost anywhere
-- Easy setup => copy and paste and you are done!
+
+- Your Raspberry Pi, a shared web-hosting, a virtual machine or localhost
+- Easy setup => copy and paste the source code and you are done!
+- Use a lightweight Sqlite database instead of Mysql or Postgresql
+- Auto-update from the user interface
+
+### Readability
+
 - CSS optimized for readability
-- Keeps history of read items
+- Responsive design
-- Remove Feedburner Ads and analytics trackers
+
-- Import/Export of OPML feeds
+### Privacy and security
-- Feed updates via a cronjob or with the user interface with one click
+
-- Use secure HTTP headers (only external images and Youtube/Vimeo/Dailymotion videos are allowed)
+- Remove Feedburner Ads and analytics trackers (1x1 pixels)
 - Open external links inside a new tab with a `rel="noreferrer"` attribute
-- Mobile CSS (responsive design)
+- Use secure HTTP headers (only external images and Youtube/Vimeo/Dailymotion videos are allowed)
-- Keyboard shortcuts
+- Article content is filtered before being displayed
-- Basic bookmarks
+
+### Polyglot
+
 - Translated in English, French, German, Italian, Czech, Spanish, Portuguese and Simplified Chinese
 - RTL languages support
-- Themes
+
-- Alternative login with a Google Account or Mozilla Persona
+### Users management
-- **Full article download for feeds that display only a summary** (website scraper based on Xpath rules)
+
-- Auto-update from the user interface
+- Alternate authentication with a Google Account or Mozilla Persona
 - Multiple databases (each user has his own database)
 
+### Awesome features
+
+- Keyboard shortcuts
+- Full article download for feeds that display only a summary (website scraper based on Xpath rules)
+- Feed updates via a cronjob or with the user interface with one click
+
+### More
+
+- Keeps history of read items
+- Basic bookmarks
+- Import/Export of OPML feeds
+- Themes
+
+Requirements
+------------
+
+- Recent version of libxml2 >= 2.7.x (version 2.6.32 on Debian Lenny is not supported anymore)
+- PHP >= 5.3.3
+- PHP XML extensions (SimpleXML, DOM...)
+- PHP Sqlite extension
+- cURL extension for PHP or Stream Context with `allow_url_fopen=On`
+
+Documentation
+-------------
+
+- [Installation and updates](docs/installation-and-updates.markdown)
+- [Cronjob](docs/cronjob.markdown)
+- [Advanced configuration](docs/config.markdown)
+- [Full article download](docs/full-article-download.markdown)
+- [Multiple users](docs/multiple-users.markdown)
+- [Translations](docs/translations.markdown)
+- [Themes](docs/themes.markdown)
+- [Session](docs/session.markdown)
+- [API documentation](http://miniflux.net/api.html)
+- [FAQ](docs/faq.markdown)
+
 Todo and known bugs
 -------------------
 
@@ -75,31 +120,3 @@ People who sent a pull-request, report a bug, make a new theme or share a super
 - Ygbillet: https://github.com/ygbillet
 
 Many people also sent bug reports and feature requests.
-
-ChangeLog
----------
-
-- <http://miniflux.net/changes.html>
-
-Requirements
-------------
-
-- Recent version of libxml2 >= 2.7.x (version 2.6.32 on Debian Lenny is not supported anymore)
-- PHP >= 5.3.3
-- PHP XML extensions (SimpleXML, DOM...)
-- PHP Sqlite extension
-- cURL extension for PHP or stream context with (`allow_url_fopen=On`)
-- Short tags enabled for PHP < 5.4
-
-Documentation
--------------
-
-- [Installation and updates](docs/installation-and-updates.markdown)
-- [Cronjob](docs/cronjob.markdown)
-- [Advanced configuration](docs/config.markdown)
-- [Full article download](docs/full-article-download.markdown)
-- [Translations](docs/translations.markdown)
-- [Themes](docs/themes.markdown)
-- [Session](docs/session.markdown)
-- [API documentation](http://miniflux.net/api.html)
-- [FAQ](docs/faq.markdown)

docs/faq.markdown

@@ -1,32 +1,42 @@
 FAQ
 ===
 
-How does Miniflux update my feeds from the user interface?
+### How does Miniflux update my feeds from the user interface?
-----------------------------------------------------------
 
 Miniflux uses an Ajax request to refresh each subscription.
 By default, there is only 5 feeds updated in parallel.
 
-I have 600 subscriptions, can Miniflux handle that?
+### I have 600 subscriptions, can Miniflux handle that?
----------------------------------------------------
 
 Probably, but your life is cluttered.
 
-Why are there no categories? Why is feature X missing?
+### Why are there no categories? Why is feature X missing?
-------------------------------------------------------
 
-Miniflux is a minimalist software. Less is more.
+Miniflux is a minimalist software. _Less is more_.
 
-I found a bug, what next?
+Sorry, I don't plan to have categories or tags.
--------------------------
+
+### I found a bug, what next?
 
 Report the bug to the [issues tracker](https://github.com/fguillot/miniflux/issues) and I will fix it.
 
 You can report feeds that doesn't works properly too.
 
-What browser is compatible with Miniflux?
+### What browser is compatible with Miniflux?
-------------------------------------------
 
 Miniflux is tested with the latest versions of Mozilla Firefox, Google Chrome and Safari.
 
 I don't use Microsoft products, and as such I have no idea if Miniflux works correctly with Internet Explorer.
+
+### How to setup Miniflux on OVH?
+
+OVH shared web-hosting can use different PHP versions.
+To have Miniflux working properly you have to use a custom `.htaccess` like that:
+
+```
+SetEnv PHP_VER 5_4
+SetEnv ZEND_OPTIMIZER 1
+SetEnv MAGIC_QUOTES 0
+```
+
+You can also just rename the file `.htaccess_ovh` to `.htaccess`.

docs/installation-and-updates.markdown

@@ -6,7 +6,7 @@ Installation
 
 ### From the archive:
 
-1. You must have a web server with PHP installed (version 5.3.7 minimum) with the Sqlite and XML extensions
+1. You must have a web server with PHP installed (version 5.3.3 minimum) with the Sqlite and XML extensions
 2. Download the source code and copy the directory `miniflux` where you want
 3. Check if the directory `data` is writeable (Miniflux stores everything inside a Sqlite database)
 4. With your browser go to <http://yourpersonalserver/miniflux>

docs/multiple-users.markdown

@@ -0,0 +1,20 @@
+Multiple users
+==============
+
+Since the begining, Miniflux was a single user software.
+However, it is now possible to create multiple databases.
+Each user have his own Sqlite database and people can choose which database they want to use before the authentication.
+
+To create a new database:
+
+1. Go to the preferences page
+2. Scroll-down to the database section
+3. Click on the link "Add a new database"
+4. Fill the form (db name, the new username and password) and save
+5. If you logout, on the login page you can choose the database you want to use
+
+If you use the cronjob, to select the database, use the parameter `--database` like that:
+
+```bash
+php cronjob.php --database=db2.sqlite
+```