Update documentation

This commit is contained in:
Frédéric Guillot 2014-11-07 20:41:09 -05:00
parent 1ac40097ed
commit e26a1873ef
4 changed files with 7 additions and 6 deletions

View File

@ -7,12 +7,13 @@ That means you can use mobile applications compatible with Fever.
This feature have been tested with the following apps: This feature have been tested with the following apps:
- [Press for Android](http://twentyfivesquares.com/press/) - [Press for Android](http://twentyfivesquares.com/press/)
- [Reeder 2](http://reederapp.com/)
Configuration Configuration
------------- -------------
Miniflux generates a random password for the Fever API. Miniflux generates a random password for the Fever API.
All information are available from the **preferences page**. All information are available from the page **preferences > api**.
- URL: http://your_miniflux_url/fever/ - URL: http://your_miniflux_url/fever/
- Username: Your username - Username: Your username

View File

@ -4,7 +4,7 @@ Installation instructions
Installation Installation
------------ ------------
### From the archive: ### From the archive (stable version)
1. You must have a web server with PHP installed (version 5.3.3 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 2. Download the source code and copy the directory `miniflux` where you want
@ -14,7 +14,7 @@ Installation
6. Start to use the software 6. Start to use the software
7. Don't forget to change your password! 7. Don't forget to change your password!
### From the repository: ### From the repository (development version)
1. `git clone https://github.com/fguillot/miniflux.git` 1. `git clone https://github.com/fguillot/miniflux.git`
2. Go to the third step just above 2. Go to the third step just above

View File

@ -7,7 +7,7 @@ Each user have his own Sqlite database and people can choose which database they
To create a new database: To create a new database:
1. Go to the preferences page 1. Go to the page **preferences > about**
2. Scroll-down to the database section 2. Scroll-down to the database section
3. Click on the link "Add a new database" 3. Click on the link "Add a new database"
4. Fill the form (db name, the new username and password) and save 4. Fill the form (db name, the new username and password) and save

View File

@ -1,7 +1,7 @@
Upgrade to a new version Upgrade to a new version
======================== ========================
### From the archive: ### From the archive (stable version)
1. Close your session (logout) 1. Close your session (logout)
2. Rename your actual miniflux directory (to keep a backup) 2. Rename your actual miniflux directory (to keep a backup)
@ -10,7 +10,7 @@ Upgrade to a new version
5. Login and check if everything is ok 5. Login and check if everything is ok
6. Remove the old miniflux directory 6. Remove the old miniflux directory
### From the repository: ### From the repository (development version)
1. Close your session (logout) 1. Close your session (logout)
2. `git pull` 2. `git pull`