blob: e01b19776e32ccf20e36b4c13c86ce02558e2fbe (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
|
# NB Reader
Rss reader *(web based)* for Newsbeuter.
_NOTE: Alpha-release_
:Author: vkrishn@insteps.net
:Date: 2015-10-23
:Version: 0.1.2
#### Table of Contents
1. [Features](#features)
2. [Features (todo)](#features-todo)
3. [Why a hybrid application](#why-a-hybrid-application)
4. [Requirements / Dependencies](#requirements--dependencies)
5. [Reference](#reference)
6. [Limitations - OS compatibility, etc.](#limitations)
7. [Development - Guide for contributing to the module](#development)
## Features
1. Feed list supporting *hierarchy* in category.
2. Search on feed list.
3. Search on active rss items.
4. Responsive layout that adapts on mobile/desktop devices.
5. Mark article as read (manual).
6. Passive update of new feed in UI.
7. Support for multiple databases.
8. Search multiple databases (cli only for now).
9. Rest api for accessing via web (json).
10. Convert existing newsbeuter db to nbreader format (experimental).

## Features (TODO)
1. Add way to mark/filter articles, eg. flag, tag and bookmark.
2. Improve search on active rss (all pages).
3. Special folders.
4. Browser based settings/configs to run update/changes on backend.
5. ...

## Why a hybrid application
1. Works for me !
2. Nice cli support, simple database.
3. Simple back-end, don't need to bother rss parsing.
## Requirements / Dependencies
1. Newsbeuter
2. Sqlite3
3. Curl(default) or Wget
4. PHP 5.4+
5. Any PHP supporting web-server (tested on Apache with .htaccess file support).
6. CodeIgniter-3.x (PHP Framework)
7. File (for icon download)
8. Fossil scm, https://www.fossil-scm.org (optional),
easy way is download the precompiled single binary file.
9. Jq (optional)
10.
## Reference
## Limitations
## Development
|