Browse Source

Draft documentation

tags/0.6.0
J. King 6 months ago
parent
commit
a8e6487001
3 changed files with 23 additions and 2 deletions
  1. 9
    0
      CHANGELOG
  2. 8
    2
      README.md
  3. 6
    0
      UPGRADING

+ 9
- 0
CHANGELOG View File

@@ -1,3 +1,12 @@
1
+Version 0.6.0 (????-??-??)
2
+==========================
3
+
4
+New features:
5
+- Support for PostgreSQL databases (via PDO)
6
+
7
+Changes:
8
+- Improve performance of common database queries by 80-90%
9
+
1 10
 Version 0.5.1 (2018-11-10)
2 11
 ==========================
3 12
 

+ 8
- 2
README.md View File

@@ -4,7 +4,7 @@ The Arsse is a news aggregator server which implements multiple synchronization
4 4
 
5 5
 At present the software should be considered in an "alpha" state: though its core subsystems are covered by unit tests and should be free of major bugs, not everything has been rigorously tested. Additionally, many features one would expect from other similar software have yet to be implemented. Areas of future work include:
6 6
 
7
-- Support for more database engines (PostgreSQL, MySQL, MariaDB)
7
+- Support for more database engines (MySQL, MariaDB)
8 8
 - Providing more sync protocols (Google Reader, Fever, others)
9 9
 - Better packaging and configuration samples
10 10
 
@@ -16,7 +16,9 @@ The Arsse has the following requirements:
16 16
 - PHP 7.0.7 or later with the following extensions:
17 17
     - [intl](http://php.net/manual/en/book.intl.php), [json](http://php.net/manual/en/book.json.php), [hash](http://php.net/manual/en/book.hash.php), and [pcre](http://php.net/manual/en/book.pcre.php)
18 18
     - [dom](http://php.net/manual/en/book.dom.php), [simplexml](http://php.net/manual/en/book.simplexml.php), and [iconv](http://php.net/manual/en/book.iconv.php) (for picoFeed)
19
-    - [sqlite3](http://php.net/manual/en/book.sqlite3.php) or [pdo_sqlite](http://ca1.php.net/manual/en/ref.pdo-sqlite.php)
19
+    - Either of:
20
+        - [sqlite3](http://php.net/manual/en/book.sqlite3.php) or [pdo_sqlite](http://ca1.php.net/manual/en/ref.pdo-sqlite.php) for SQLite databases
21
+        - [pdo_pgsql](http://ca1.php.net/manual/en/ref.pdo-pgsql.php) for PostgreSQL 9.1 or later databases
20 22
 - Privileges to create and run daemon processes on the server
21 23
 
22 24
 ## Installation
@@ -69,6 +71,10 @@ The Arsse is made available under the permissive MIT license.  See the `LICENSE`
69 71
 
70 72
 Please refer to `CONTRIBUTING.md` for guidelines on contributing code to The Arsse.
71 73
 
74
+## Database compatibility notes
75
+
76
+Functionally there is no reason to prefer either SQLite or PostgreSQL over the other. SQLite, however, is significantly simpler to set up in most cases, requiring only read and write access to a containing directory in order to function. PostgreSQL may perform better than SQLite when serving hundreds of users or more, but this has not been tested.
77
+
72 78
 ## Protocol compatibility notes
73 79
 
74 80
 ###  General

+ 6
- 0
UPGRADING View File

@@ -9,6 +9,12 @@ When upgrading between any two versions of The Arsse, the following are usually
9 9
 - If installing from source, update dependencies with `composer install -o --no-dev`
10 10
 
11 11
 
12
+Upgrading from 0.5.1 to 0.6.0
13
+=============================
14
+
15
+- The database schema has changed from rev3 to rev4; if upgrading the database manually, apply the 3.sql file
16
+
17
+
12 18
 Upgrading from 0.2.1 to 0.3.0
13 19
 =============================
14 20
 

Loading…
Cancel
Save