jan/miniflux-legacy
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Merge branch 'master' of github.com:fguillot/miniflux

Browse Source
This commit is contained in:
Frederic Guillot 2013-07-04 18:45:54 -04:00
commit 03bff8699d
1 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.markdown
View File

@ -9,10 +9,10 @@ Features
- Host anywhere (shared hosting, vps or localhost) - Host anywhere (shared hosting, vps or localhost)
- Easy setup => copy and paste and you are done! - Easy setup => copy and paste and you are done!
- CSS optimized for readability - CSS optimized for readability
- Keep an history of read items - Keeps history of read items
- Remove Feedburner Ads and analytics trackers - Remove Feedburner Ads and analytics trackers
- Import/Export OPML feeds - Import/Export of OPML feeds
- Feeds update by a cronjob or with the user interface in one click - Feed updates via a cronjob or with the user interface with one click
- Protected by a login/password (only one possible user) - Protected by a login/password (only one possible user)
- Use secure headers (only external images and Youtube/Vimeo videos are allowed) - Use secure headers (only external images and Youtube/Vimeo videos are allowed)
- Open external links inside a new tab with a `rel="noreferrer"` attribute - Open external links inside a new tab with a `rel="noreferrer"` attribute
@ -58,8 +58,8 @@ Installation
------------ ------------
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.7 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
3. Check if the directory data is writeable (Miniflux store everything inside a Sqlite database) 3. Check if the directory `data` is writeable (Miniflux stores everything inside a Sqlite database)
4. With your browser go to <http://yourpersonalserver/miniflux> 4. With your browser go to <http://yourpersonalserver/miniflux>
5. The default login and password is **admin/admin** 5. The default login and password is **admin/admin**
6. Start to use the software 6. Start to use the software
@ -67,7 +67,7 @@ Installation
FAQ FAQ
---- ----
### How to update your feeds with a cronjob? ### How do I update my feeds with a cronjob?
You just need to be inside the directory `miniflux` and run the script `cronjob.php`. You just need to be inside the directory `miniflux` and run the script `cronjob.php`.
@ -94,16 +94,16 @@ Examples:
Note: cronjob.php can also be called from the web; in this case specify the options as GET variables. Note: cronjob.php can also be called from the web; in this case specify the options as GET variables.
Example: <http://yourpersonalserver/miniflux/cronjob.php?call-interval=4&update-interval=60> Example: <http://yourpersonalserver/miniflux/cronjob.php?call-interval=4&update-interval=60>
### How Miniflux update my feeds from the user interface? ### How does Miniflux update my feeds from the user interface?
Miniflux use an Ajax request to refresh each subscription. Miniflux uses an Ajax request to refresh each subscription.
By default, there is only 5 feeds updated in parallel. By default, there is only 5 feeds updated in parallel.
### I have 600 subscriptions, how Miniflux handle that? ### I have 600 subscriptions, can Miniflux handle that?
Your life is cluttered. Your life is cluttered.
### Why there is no categories? Why the feature X is 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.
@ -115,6 +115,6 @@ You can report feeds that doesn't works properly too.
### Which browser is compatible with Miniflux? ### Which browser is compatible with Miniflux?
Miniflux is tested with the last version of Mozilla Firefox, Google Chrome and Safari. Miniflux is tested with the latest versions of Mozilla Firefox, Google Chrome and Safari.
I don't use Microsoft products, then I have no idea if Miniflux works correctly with Internet Explorer. I don't use Microsoft products, then I have no idea if Miniflux works correctly with Internet Explorer.