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

Update docs

Browse Source
This commit is contained in:
Frédéric Guillot 2014-12-29 17:10:37 -05:00
parent c43d9dd773
commit f48a1a2546
3 changed files with 12 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/faq.markdown
View File

@ -31,7 +31,7 @@ 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.
Miniflux is also tested on mobile devices Android (Moto G) and Ipad Mini (Retina).
How to setup Miniflux on OVH shared-hosting?
--------------------------------------------

12
docs/fever.markdown
View File

@ -7,7 +7,7 @@ That means you can use mobile applications compatible with Fever.
This feature have been tested with the following apps:
- [Press for Android](http://twentyfivesquares.com/press/)
- [Reeder 2](http://reederapp.com/)
- [Reeder 2](http://reederapp.com/) (iOS and OSX)
Configuration
-------------
@ -19,10 +19,16 @@ All information are available from the page **preferences > api**.
- Username: Your username
- Password: random (visible on the settings page)
Multiple databases/users
------------------------
Multiple databases can be used with the Fever API if you have Apache and the `mod_rewrite` enabled.
The Fever URL becomes `http:///your_miniflux_url/myuser.sqlite/`.
Notes
-----
- Links, sparks, kindling, favicons and groups are not supported.
- Links, sparks, kindling and groups are not supported.
- All feeds will be under a category "All" because Miniflux doesn't support categories.
- Only JSON responses are handled.
- If you have multiple users with Miniflux, that will works only with the default user.

4
docs/full-article-download.markdown
View File

@ -20,7 +20,7 @@ However the content grabber doesn't work very well with all websites.
How to write a grabber rules file?
----------------------------------
Add a PHP file to the directory `vendor\fguillot\PicoFeed\Rules`, the filename must be the domain name:
Add a PHP file to the directory `vendor/fguillot/picofeed/lib/PicoFeed/Rules`, the filename must be the domain name:
Example with the BBC website, `www.bbc.co.uk.php`:
@ -55,6 +55,6 @@ Don't forget to send a pull request or a ticket to share your contribution with
List of content grabber rules
-----------------------------
Rules are stored here: [vendor/PicoFeed/Rules](https://github.com/fguillot/miniflux/tree/master/vendor/PicoFeed/Rules)
[List of existing rules on the repository](https://github.com/fguillot/miniflux/tree/master/vendor/fguillot/picofeed/lib/PicoFeed/Rules)
If you want to add new rules, just open a ticket and I will do it.