aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorV.Krishn <vkrishn4@gmail.com>2021-11-28 08:34:51 +0530
committerV.Krishn <vkrishn4@gmail.com>2021-11-28 08:34:51 +0530
commit8edaac4572f7b3b0a05158e4c6b1be2d2cfc3dde (patch)
tree90669aaa56e6618a10d51d5fb16ba9e3d0009bf5
parent64579b81d78274ea491eb30c65f56e09c27ba4e5 (diff)
downloadnbreader-8edaac4572f7b3b0a05158e4c6b1be2d2cfc3dde.tar.bz2
clean docs
-rw-r--r--README.md11
-rw-r--r--doc/quickstart.md2
2 files changed, 9 insertions, 4 deletions
diff --git a/README.md b/README.md
index 58ba313..37dcc7e 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,14 @@
# NB Reader
-Rss reader *(web based)* for Newsbeuter.
+Rss reader *(web based)* for Newsbeuter/Newsboat.
_NOTE: Beta-release_
:Author: vkrishn@insteps.net
+
:Date: 2020-10-23
+
:Version: 0.2.0-beta1
#### Table of Contents
@@ -47,7 +49,7 @@ http://dev.insteps.net/rss/
## Requirements / Dependencies
-1. Newsbeuter (or Newsboat, make link for Newsbeuter)
+1. Newsbeuter (or Newsboat, with link for Newsbeuter)
2. Sqlite3
3. Curl(default) or Wget
4. PHP 5.4+
@@ -55,8 +57,11 @@ http://dev.insteps.net/rss/
6. CodeIgniter-3.x (PHP Framework)
7. File (for icon download)
8. Git/Fossil scm, (optional),
+
url: https://www.fossil-scm.org (optional),
- easy way is download the precompiled single binary file.
+
+ easy way is to download the precompiled single binary file.
+
9. Jq (optional)
10.
diff --git a/doc/quickstart.md b/doc/quickstart.md
index 7519c8d..bafde80 100644
--- a/doc/quickstart.md
+++ b/doc/quickstart.md
@@ -34,7 +34,7 @@ Note: the commands below may require sudo or root access.
14. edit apps/web/config/newsbeuter.php and change
- `$config['newsbeuter']['be']['path'] = '<WEBFOLDER>/nbreader';`
+ `$config['newsbeuter']['be']['path'] = '<WEBFOLDER>/nbreader';`
15. `cd <WEBFOLDER>`
16. `ln -s nbreader/public rss`